i3bar: fix clang compilation error by using const size_t (#6349)

Thanks to Shouη (@Shoun2137 on GitHub) for the suggestion.

.clang-format

@@ -0,0 +1,14 @@
+AllowShortBlocksOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakBeforeMultilineStrings: false
+BasedOnStyle: google
+ColumnLimit: 0
+ForEachMacros: [ TAILQ_FOREACH, TAILQ_FOREACH_REVERSE, SLIST_FOREACH, CIRCLEQ_FOREACH, CIRCLEQ_FOREACH_REVERSE, NODES_FOREACH, NODES_FOREACH_REVERSE, FOREACH_NONINTERNAL]
+IndentWidth: 4
+InsertBraces: true
+PointerBindsToType: false
+SortIncludes: false
+SpaceBeforeParens: ControlStatements
+TypenameMacros: [ SLIST_HEAD, SLIST_ENTRY, LIST_HEAD, LIST_ENTRY, SIMPLEQ_HEAD, SIMPLEQ_ENTRY, TAILQ_HEAD, TAILQ_ENTRY, CIRCLEQ_HEAD, CIRCLEQ_ENTRY ]

.dockerignore

@@ -0,0 +1 @@
+.git

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{c,h}]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true

.github/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+## i3status/i3lock bug reports and feature requests
+
+Note that bug reports and feature requests for related projects should be filed in the corresponding repositories for [i3status](https://github.com/i3/i3status) and [i3lock](https://github.com/i3/i3lock).
+
+## i3 bug reports
+
+1. Read the [debugging instructions](https://i3wm.org/docs/debugging.html).
+2. Make sure you include a link to your logfile in your report (section 3).
+3. Make sure you include the i3 version number in your report (section 1).
+4. Please be aware that we cannot support compatibility issues with
+   closed-source software, as digging into compatibility problems without
+   having access to the source code is too time-consuming. Additionally,
+   experience has shown that often, the software in question is responsible for
+   the issue. Please raise an issue with the software in question, not i3.
+5. Please note that i3 does not support compositors (e.g. compton). If you
+   encountered the issue you are about to report while using a compositor,
+   please try reproducing it without a compositor.
+
+## i3 feature requests
+
+1. Read the [project goals](https://i3wm.org) on the website and make sure that
+   they are compatible with the feature you want to suggest.
+2. We are generally happy with the current feature set of i3 and instead focus
+   on maintenance such as stability and fixing bugs. New features will rarely
+   be considered if they require additional configuration and/or commands, or
+   if they add significant complexity (either through the exposed configuration
+   or mental complexity) to the project.
+3. Explain in detail what problem the feature addresses and why existing
+   features fall short.
+4. Consider whether the feature could instead be implemented using the
+   [IPC](https://i3wm.org/docs/ipc.html) or other external tooling.
+
+## Pull requests
+
+* Before sending a pull request for new features, please check with us that the
+  feature is something we want to see in i3 by opening an issue which has
+  ”feature request” or ”enhancement” in its title.
+* Use the `next` branch for developing and sending your pull request.
+* Use `clang-format` to format your code.
+* Run the [testsuite](https://i3wm.org/docs/testsuite.html)
+* If your changes should be reported on the next release's changelog, also
+  add a small single-line file starting with a number (see examples) containing
+  a short explanation of your change either in the
+  [changes](../release-notes/changes) or the
+  [bugfixes](../release-notes/bugfixes/) folder. Example of changes that should
+  be reported are bug fixes present in the latest stable version of i3 and new
+  enhancements. Example of changes that should not be reported are minor code
+  improvements, documentation, regression and fixes for bugs that were
+  introduced in the `next` branch.
+
+## Finding something to do
+
+* Find a [reproducible bug](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Areproducible+label%3Abug+) from the issue tracker. These issues have been reviewed and confirmed by a project contributor.
+* Find an [accepted enhancement](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Aaccepted+label%3Aenhancement) from the issue tracker. These have been approved and are ok to start working on.
+
+There's an [overview of the codebase](https://i3wm.org/docs/hacking-howto.html) available to get you started.

.github/GOVERNANCE.md

@@ -0,0 +1,30 @@
+# i3 project governance
+
+## Overview
+
+The i3 project uses a governance model commonly described as Benevolent
+Dictator For Life (BDFL). This document outlines our understanding of what this
+means.
+
+## Roles
+
+* user: anyone who interacts with the i3 project
+* core contributor: a handful of people who have contributed significantly to
+  the project by any means (issue triage, support, documentation, code, etc.).
+  Core contributors are recognizable via GitHub’s “Member” badge.
+* BDFL: a single individual who makes decisions when consensus cannot be
+  reached. i3’s current BDFL is [@stapelberg](https://github.com/stapelberg).
+
+## Decision making process
+
+In general, we try to reach consensus in discussions. In case consensus cannot
+be reached, the BDFL makes a decision.
+
+For feature requests and code contributions specifically, the values with which
+we consider them can be found on the bottom of https://i3wm.org/. These values
+are not set in stone and are to be treated as guiding principles, not absolute
+rules that must be followed in every case.
+
+## Contribution process
+
+Please see [CONTRIBUTING](CONTRIBUTING.md).

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,73 @@
+<!--
+PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
+-->
+
+## I'm submitting a…
+<!-- 
+Check one of the following options with "x".
+
+Please note that at this point we focus on maintaining i3 and fixing bugs, and will rarely consider features which require further configuration or significant complexity.
+In such cases you should consider and present specific benefits derived from adding this feature such that it can be weighed against the cost of additional complexity and maintenance.
+-->
+<pre>
+[ ] Bug
+[ ] Feature Request
+[ ] Documentation Request
+[ ] Other (Please describe in detail)
+</pre>
+
+## Current Behavior
+<!--
+Describe the current behavior,
+e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
+-->
+
+## Expected Behavior
+<!--
+Describe the desired behavior you expect after mitigation of the issue,
+e.g., »The window left next to the current window should be focused.«
+-->
+
+## Reproduction Instructions
+<!--
+For bug reports, please provide detailed instructions on how the bug can be reproduced.
+For feature requests you can remove this section.
+
+E.g., »Open three windows in a V[A H[B C]] layout on a new workspace«
+-->
+
+## Environment
+<!--
+Please include your exact i3 version.
+Note that we only support the latest major release and the current development version. If you are using an older version of i3, please first update to the current release version and reproduce the issue there.
+-->
+Output of `i3 --moreversion 2>&-`:
+<pre>
+i3 version: 
+</pre>
+
+<!--
+For bug reports, please include your (complete) i3 config with which the issue occurs. You can either paste the file directly or provide a link to a service such as pastebin.
+
+If you would like to help debugging the issue, please try to reduce the config such that it is as close to the default config as possible while still reproducing the issue. This can help us bisect the root cause.
+-->
+<pre>
+</pre>
+
+<!--
+Providing a logfile can help us trace the root cause of an issue much quicker. You can learn how to generate the logfile here:
+https://i3wm.org/docs/debugging.html
+
+Providing the logfile is optional.
+-->
+<pre>
+Logfile URL:
+</pre>
+
+<!--
+Please also answer the questions below to help us process your issue faster. If you have any other information to share, please add it here as well.
+-->
+<pre>
+- Linux Distribution & Version:
+- Are you using a compositor (e.g., xcompmgr or compton):
+</pre>

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,107 @@
+name: Bug Report
+description: Create a report to help us improve.
+labels: [bug]
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome
+      options:
+        - label: Yes, I'm using the latest major release or the current development version. These are the only supported versions.
+          required: true
+        - label: Yes, I've searched similar issues and discussions on GitHub and didn't find any.
+          required: true
+
+  - type: textarea
+    id: current
+    attributes:
+      label: Current Behavior
+      placeholder: |-
+        Describe the current behavior,
+        e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      placeholder: |-
+        Describe the desired behavior you expect after mitigation of the issue,
+        e.g., »The window left next to the current window should be focused.«
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction Instructions
+      placeholder: |-
+        Please provide detailed instructions on how the bug can be reproduced.
+        E.g., »Open three windows in a V[A H[B C]] layout on a new workspace«
+    validations:
+      required: true
+
+  - type: textarea
+    id: version
+    attributes:
+      label: i3 version
+      description: |-
+        Paste the output of
+        ```
+        i3 --moreversion 2>&-
+        ```
+      render: text
+    validations:
+      required: true
+
+  - type: textarea
+    id: config
+    attributes:
+      label: Config file
+      description: |-
+        Please include your (complete) i3 config with which the issue occurs.
+
+        If you would like to help debugging the issue, please try to reduce the config such that it is as close to the default config as possible while still reproducing the issue. This can help us bisect the root cause.
+      render: text
+    validations:
+      required: true
+
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution & Version
+    validations:
+      required: true
+
+  - type: dropdown
+    id: compositor
+    attributes:
+      label: Are you using a compositor?
+      description: |-
+        Try running
+        ```shell
+        pidof picom
+        pidof compton
+        ```
+        If any IDs show up, you are running a compositor
+      options:
+        - I don't know
+        - I am sure I don't run any compositor
+        - picom
+        - compton
+        - Other
+    validations:
+      required: true
+
+  - type: input
+    id: verbose-output
+    attributes:
+      label: Logfile
+      description: |-
+        Providing the URL to a logfile can help us trace the root cause of an issue much quicker. You can learn how to generate the logfile here:
+        https://i3wm.org/docs/debugging.html
+
+        Providing the logfile is optional.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Userguide
+    url: https://i3wm.org/docs/userguide.html
+    about: i3 User’s Guide
+  - name: Ask a question or request support for using i3
+    url: https://github.com/i3/i3/discussions/new
+    about: Ask a question or request support for using i3

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,57 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: [enhancement]
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome
+      options:
+        - label: Yes, I've searched similar issues and discussions on GitHub and didn't find any.
+          required: true
+
+  - type: checkboxes
+    id: impact
+    attributes:
+      label: Impact
+      description: |-
+        Please note that at this point we focus on maintaining i3 and fixing bugs, and will rarely consider features which require further configuration or significant complexity.
+        In such cases you should consider and present specific benefits derived from adding this feature such that it can be weighed against the cost of additional complexity and maintenance.
+        Keep in mind that i3 provides a powerful way to interact with it through its IPC interface: https://i3wm.org/docs/ipc.html.
+      options:
+        - label: This feature requires new configuration and/or commands
+          required: false
+
+
+  - type: textarea
+    id: current
+    attributes:
+      label: Current Behavior
+      placeholder: |-
+        Describe the current behavior,
+        e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
+    validations:
+      required: true
+
+  - type: textarea
+    id: desired
+    attributes:
+      label: Desired Behavior
+      placeholder: |-
+        Describe the desired behavior you expect after mitigation of the issue,
+        e.g., »The window left next to the current window should be focused.«
+    validations:
+      required: true
+
+  - type: textarea
+    id: version
+    attributes:
+      label: i3 version
+      description: |-
+        Paste the output of
+        ```
+        i3 --moreversion 2>&-
+        ```
+      render: text
+    validations:
+      required: true

.github/workflows/main.yml

@@ -0,0 +1,98 @@
+name: GitHub Actions
+
+on:
+  push:
+    branches: [ next, master, actions ]
+  pull_request:
+    branches: [ next ]
+
+jobs:
+  build:
+    name: build and test
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        compiler: [gcc, clang]
+    env:
+      CC: ${{ matrix.compiler }}
+      DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
+      DOCKER_EMAIL: ${{ secrets.DOCKER_EMAIL }}
+      DOCKER_USER: ${{ secrets.DOCKER_USER }}
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      BALTO_TOKEN: ${{ secrets.BALTO_TOKEN }}
+
+    steps:
+    - uses: actions/checkout@v4
+    - run: git fetch --prune --unshallow
+    - name: construct container name
+      run: |
+        echo "BASENAME=i3wm/travis-base:$(date +'%Y-%m')-$(./travis/ha.sh travis/travis-base.Dockerfile)" >> $GITHUB_ENV
+        echo "BASENAME_UBUNTU=i3wm/travis-base-ubuntu:$(date +'%Y-%m')-$(./travis/ha.sh travis/travis-base-ubuntu.Dockerfile)" >> $GITHUB_ENV
+    - name: fetch or build Docker container
+      run: |
+        docker pull ${{ env.BASENAME }} || ./travis/docker-build-and-push.sh ${{ env.BASENAME }} travis/travis-base.Dockerfile
+    - name: fetch or build extra Docker containers
+      if: github.ref == 'refs/heads/next' && matrix.compiler == 'gcc'
+      run: |
+        docker pull ${{ env.BASENAME_UBUNTU }} || ./travis/docker-build-and-push.sh ${{ env.BASENAME_UBUNTU }} travis/travis-base-ubuntu.Dockerfile
+    - name: build i3
+      run: |
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 -e CC ${{ env.BASENAME }} /bin/sh -c 'rm -rf build; mkdir -p build && cd build && CFLAGS="-Wformat -Wformat-security -Wextra -Wno-unused-parameter -Wstrict-prototypes -Wmissing-prototypes -Werror -fno-common -D_FORTIFY_SOURCE=3" meson setup .. -Ddocs=true -Dmans=true -Db_sanitize=address --buildtype=debugoptimized && ninja -v'
+    - name: Upload docs html for manual inspection
+      uses: actions/upload-artifact@v4
+      with:
+        name: i3-docs
+        path: |
+          build/*.html
+      if: matrix.compiler == 'gcc'
+    - name: check spelling
+      run: |
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 ${{ env.BASENAME }} ./travis/check-spelling.pl
+    - name: run i3 tests
+      run: |
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 -e CC ${{ env.BASENAME }} ./travis/run-tests.sh
+    - name: Archive test logs
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-logs
+        path: build/testsuite-*
+      if: ${{ failure() }}
+    - name: build dist tarball
+      run: |
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 -e CC ${{ env.BASENAME }} /bin/sh -c 'rm -rf distbuild; mkdir distbuild && cd distbuild && meson setup .. -Ddocs=true -Dmans=true && meson dist --no-tests'
+    - name: build Debian packages
+      if: github.ref == 'refs/heads/next' && matrix.compiler == 'gcc'
+      run: |
+        echo "::group::Debian amd64"
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 ${{ env.BASENAME }} ./travis/debian-build.sh deb/debian-amd64/DIST
+        echo "::endgroup::"
+        echo "::group::Ubuntu amd64"
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 ${{ env.BASENAME_UBUNTU }} ./travis/debian-build.sh deb/ubuntu-amd64/DIST
+        echo "::endgroup::"
+    - name: push Debian packages to balto
+      if: github.ref == 'refs/heads/next' && matrix.compiler == 'gcc'
+      run: |
+        travis/push-balto.sh
+    - name: build docs
+      if: github.ref == 'refs/heads/next' && matrix.compiler == 'gcc'
+      run: |
+        docker run -v $PWD:/usr/src/i3/ -w /usr/src/i3 ${{ env.BASENAME }} ./travis/docs.sh
+    - name: push docs to GitHub pages
+      if: github.ref == 'refs/heads/next' && matrix.compiler == 'gcc'
+      run: |
+        travis/deploy-github-pages.sh
+  formatting:
+    name: Check formatting
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: check & print release notes
+      run: ./release-notes/generator.pl
+    - name: Install dependencies
+      run: |
+        sudo apt-get install -y clang-format-15
+    - name: Check formatting
+      run: clang-format-15 --dry-run --Werror $(git ls-files '*.c' '*.h')
+    - name: Verify safe wrapper functions are used
+      run: ./travis/check-safe-wrappers.sh

.gitignore

@@ -6,12 +6,20 @@ include/all.h.pch
 *.swp
 *.gcda
 *.gcno
+*.dSYM
 test.commands_parser
 test.config_parser
 testcases/MYMETA.json
 testcases/MYMETA.yml
 testcases/blib/
 testcases/pm_to_blib
+AnyEvent-I3/Makefile
+AnyEvent-I3/META.yml
+AnyEvent-I3/MYMETA.json
+AnyEvent-I3/MYMETA.yml
+AnyEvent-I3/blib/
+AnyEvent-I3/inc/
+AnyEvent-I3/pm_to_blib
 *.output
 *.tab.*
 *.yy.c
@@ -31,3 +39,14 @@ docs/*.html
 !/docs/refcard.html
 i3-command-parser.stamp
 i3-config-parser.stamp
+.clang_complete
+compile_commands.json
+/.ccls-cache
+/.clangd
+LAST_VERSION
+
+# We recommend building in a subdirectory called build.
+# If you chose a different directory name,
+# it is up to you to arrange for it to be ignored by git,
+# e.g. by listing your directory in .git/info/exclude.
+/build

AnyEvent-I3/Changes

@@ -0,0 +1,82 @@
+Revision history for AnyEvent-I3
+
+0.19    2024-04-09
+
+   * use Carp for errors (includes stacktraces)
+   * introduce (preferred) RUN_COMMAND spelling
+   * migrate tooling to ExtUtils::MakeMaker
+   * implement the tick event
+   * introduce the sync IPC command
+   * introduce the GET_BINDING_STATE IPC command
+
+0.18    2017-08-19
+
+   * support the GET_CONFIG command
+
+0.17    2017-04-09
+
+   * support the shutdown event
+   * use lib '.' for Perl 5.25.11+
+
+0.16    2014-10-03
+
+   * support the barconfig_update and binding event
+
+0.15    2013-02-18
+
+    * support the window event
+
+0.14    2012-09-22
+
+    * support the mode event
+
+0.13    2012-08-05
+
+    * support the GET_VERSION request with a fall-back to i3 --version
+
+0.12    2012-07-11
+
+    * taint mode fix: remove relative directories from $ENV{PATH}
+
+0.11    2012-07-10
+
+    * taint mode fix for FreeBSD
+
+0.10    2012-07-09
+
+    * Use i3 --get-socketpath by default for determining the socket path
+    * Bugfix: Also delete callbacks which are triggered due to an error
+
+0.09    2011-10-12
+
+    * Implement GET_BAR_CONFIG request
+
+0.08    2011-09-26
+
+    * Implement GET_MARKS request
+    * The synopsis mentioned ->workspaces, but it’s ->get_workspaces
+
+0.07    2010-11-21
+
+    * Implement GET_TREE request
+
+0.06    2010-06-16
+
+    * Add check to Makefile to abort in a Windows environment (neither i3 nor
+      unix sockets available)
+
+0.05    2010-06-09
+
+    * use getpwuid() to resolve ~ in socket paths instead of glob()
+
+0.04    2010-03-27
+
+    * use new default ipc-socket path, glob() path, bump version
+
+0.03    2010-03-26
+
+    * fix MANIFEST
+
+0.02    2010-03-23
+
+    * first upload to CPAN

AnyEvent-I3/MANIFEST

@@ -0,0 +1,13 @@
+Changes
+lib/AnyEvent/I3.pm
+Makefile.PL
+MANIFEST			This list of files
+MANIFEST.SKIP
+README
+t/00-load.t
+t/01-workspaces.t
+t/02-sugar.t
+t/boilerplate.t
+t/manifest.t
+t/pod-coverage.t
+t/pod.t

AnyEvent-I3/MANIFEST.SKIP

@@ -0,0 +1,13 @@
+^\.git/
+\.bak$
+blib/
+^Makefile$
+^Makefile.old$
+Build
+Build.bat
+^pm_to_blib
+\.tar\.gz$
+^pod2htm(.*).tmp$
+^AnyEvent-I3-
+^MYMETA.*
+^MANIFEST\.bak

AnyEvent-I3/Makefile.PL

@@ -0,0 +1,100 @@
+use strict;
+use warnings;
+
+use 5.006;
+use ExtUtils::MakeMaker;
+
+if ( $^O eq 'MSWin32' ) {
+    die "AnyEvent::I3 cannot be used on win32 (unix sockets are missing)";
+}
+
+my %meta = (
+    name        => 'AnyEvent-I3',
+    author      => 'Michael Stapelberg, C<< <michael at i3wm.org> >>',
+    license     => ['perl'],
+    'meta-spec' => { version => 2 },
+    resources   => {
+        repository => {
+            url  => 'git://github.com/i3/i3',
+            web  => 'https://github.com/i3/i3',
+            type => 'git',
+        },
+        bugtracker => {
+            web => 'https://github.com/i3/i3/issues',
+        },
+        homepage => 'https://i3wm.org/',
+        license  => ['https://dev.perl.org/licenses'],
+    },
+);
+
+my %requirements = (
+    configure_requires => {
+        'ExtUtils::MakeMaker' => 6.36,
+    },
+    build_requires => {
+        'ExtUtils::MakeMaker' => 6.36
+    },
+    runtime_requires => {
+        'AnyEvent'         => 0,
+        'AnyEvent::Handle' => 0,
+        'AnyEvent::Socket' => 0,
+        'JSON::XS'         => 0,
+    },
+    test_requires => {
+        'Test::More' => 0.80,
+    },
+);
+
+my %merged_requirements = (
+    'ExtUtils::MakeMaker' => 0,
+    'AnyEvent'            => 0,
+    'AnyEvent::Handle'    => 0,
+    'AnyEvent::Socket'    => 0,
+    'JSON::XS'            => 0,
+    'Test::More'          => 0.80,
+);
+
+$meta{prereqs}{configure}{requires} = $requirements{configure_requires};
+$meta{prereqs}{build}{requires}     = $requirements{build_requires};
+$meta{prereqs}{runtime}{requires}   = $requirements{runtime_requires};
+$meta{prereqs}{test}{requires}      = $requirements{test_requires};
+
+my %MM_Args = (
+    AUTHOR           => 'Michael Stapelberg',
+    NAME             => 'AnyEvent::I3',
+    DISTNAME         => 'AnyEvent-I3',
+    EXE_FILES        => [],
+    MIN_PERL_VERSION => '5.006',
+    VERSION_FROM     => 'lib/AnyEvent/I3.pm',
+    ABSTRACT_FROM    => 'lib/AnyEvent/I3.pm',
+    test             => {
+        TESTS => 't/*.t',
+    },
+);
+
+sub is_eumm {
+    eval { ExtUtils::MakeMaker->VERSION( $_[0] ) };
+}
+
+is_eumm(6.30) and $MM_Args{LICENSE} = $meta{license}[0];
+is_eumm(6.47_01) or delete $MM_Args{MIN_PERL_VERSION};
+is_eumm(6.52)
+  and $MM_Args{CONFIGURE_REQUIRES} = $requirements{configure_requires};
+
+is_eumm(6.57_02) and !is_eumm(6.57_07) and $MM_Args{NO_MYMETA} = 1;
+
+if ( is_eumm(6.63_03) ) {
+    %MM_Args = (
+        %MM_Args,
+        TEST_REQUIRES  => $requirements{test_requires},
+        BUILD_REQUIRES => $requirements{build_requires},
+        PREREQ_PM      => $requirements{runtime_requires},
+    );
+}
+else {
+    $MM_Args{PREREQ_PM} = \%merged_requirements;
+}
+unless ( -f 'META.yml' ) {
+    $MM_Args{META_ADD} = \%meta;
+}
+WriteMakefile(%MM_Args);

AnyEvent-I3/README

@@ -0,0 +1,40 @@
+AnyEvent-I3
+
+This module connects to the i3 window manager using the UNIX socket based
+IPC interface it provides (if enabled in the configuration file). You can
+then subscribe to events or send messages and receive their replies.
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+	perl Makefile.PL
+	make
+	make test
+	make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+    perldoc AnyEvent::I3
+
+You can also look for information at:
+
+    RT, CPAN's request tracker
+        https://rt.cpan.org/NoAuth/Bugs.html?Dist=AnyEvent-I3
+
+    The i3 window manager website
+        https://i3wm.org
+
+
+LICENSE AND COPYRIGHT
+
+Copyright (C) 2010 Michael Stapelberg
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of either: the GNU General Public License as published
+by the Free Software Foundation; or the Artistic License.
+
+See https://dev.perl.org/licenses/ for more information.

AnyEvent-I3/lib/AnyEvent/I3.pm

@@ -0,0 +1,597 @@
+package AnyEvent::I3;
+# vim:ts=4:sw=4:expandtab
+
+use strict;
+use warnings;
+use JSON::XS;
+use AnyEvent::Handle;
+use AnyEvent::Socket;
+use AnyEvent;
+use Encode;
+use Carp;
+
+=head1 NAME
+
+AnyEvent::I3 - communicate with the i3 window manager
+
+=cut
+
+our $VERSION = '0.19';
+
+=head1 VERSION
+
+Version 0.19
+
+=head1 SYNOPSIS
+
+This module connects to the i3 window manager using the UNIX socket based
+IPC interface it provides (if enabled in the configuration file). You can
+then subscribe to events or send messages and receive their replies.
+
+    use AnyEvent::I3 qw(:all);
+
+    my $i3 = i3();
+
+    $i3->connect->recv or die "Error connecting";
+    say "Connected to i3";
+
+    my $workspaces = $i3->message(TYPE_GET_WORKSPACES)->recv;
+    say "Currently, you use " . @{$workspaces} . " workspaces";
+
+...or, using the sugar methods:
+
+    use AnyEvent::I3;
+
+    my $workspaces = i3->get_workspaces->recv;
+    say "Currently, you use " . @{$workspaces} . " workspaces";
+
+A somewhat more involved example which dumps the i3 layout tree whenever there
+is a workspace event:
+
+    use Data::Dumper;
+    use AnyEvent;
+    use AnyEvent::I3;
+
+    my $i3 = i3();
+
+    $i3->connect->recv or die "Error connecting to i3";
+
+    $i3->subscribe({
+        workspace => sub {
+            $i3->get_tree->cb(sub {
+                my ($tree) = @_;
+                say "tree: " . Dumper($tree);
+            });
+        }
+    })->recv->{success} or die "Error subscribing to events";
+
+    AE::cv->recv
+
+=head1 EXPORT
+
+=head2 $i3 = i3([ $path ]);
+
+Creates a new C<AnyEvent::I3> object and returns it.
+
+C<path> is an optional path of the UNIX socket to connect to. It is strongly
+advised to NOT specify this unless you're absolutely sure you need it.
+C<AnyEvent::I3> will automatically figure it out by querying the running i3
+instance on the current DISPLAY which is almost always what you want.
+
+=head1 SUBROUTINES/METHODS
+
+=cut
+
+use Exporter qw(import);
+use base 'Exporter';
+
+our @EXPORT = qw(i3);
+
+use constant TYPE_RUN_COMMAND => 0;
+use constant TYPE_COMMAND => 0;
+use constant TYPE_GET_WORKSPACES => 1;
+use constant TYPE_SUBSCRIBE => 2;
+use constant TYPE_GET_OUTPUTS => 3;
+use constant TYPE_GET_TREE => 4;
+use constant TYPE_GET_MARKS => 5;
+use constant TYPE_GET_BAR_CONFIG => 6;
+use constant TYPE_GET_VERSION => 7;
+use constant TYPE_GET_BINDING_MODES => 8;
+use constant TYPE_GET_CONFIG => 9;
+use constant TYPE_SEND_TICK => 10;
+use constant TYPE_SYNC => 11;
+use constant TYPE_GET_BINDING_STATE => 12;
+
+our %EXPORT_TAGS = ( 'all' => [
+    qw(i3 TYPE_RUN_COMMAND TYPE_COMMAND TYPE_GET_WORKSPACES TYPE_SUBSCRIBE TYPE_GET_OUTPUTS
+       TYPE_GET_TREE TYPE_GET_MARKS TYPE_GET_BAR_CONFIG TYPE_GET_VERSION
+       TYPE_GET_BINDING_MODES TYPE_GET_CONFIG TYPE_SEND_TICK TYPE_SYNC
+       TYPE_GET_BINDING_STATE)
+] );
+
+our @EXPORT_OK = ( @{ $EXPORT_TAGS{all} } );
+
+my $magic = "i3-ipc";
+
+# TODO: auto-generate this from the header file? (i3/ipc.h)
+my $event_mask = (1 << 31);
+my %events = (
+    workspace => ($event_mask | 0),
+    output => ($event_mask | 1),
+    mode => ($event_mask | 2),
+    window => ($event_mask | 3),
+    barconfig_update => ($event_mask | 4),
+    binding => ($event_mask | 5),
+    shutdown => ($event_mask | 6),
+    tick => ($event_mask | 7),
+    _error => 0xFFFFFFFF,
+);
+
+sub i3 {
+    AnyEvent::I3->new(@_)
+}
+
+sub _call_i3 {
+    my ($args) = @_;
+
+    chomp(my $result = qx(i3 $args));
+    if ($result =~ /^([^\0]+)$/) {
+        return $1;
+    }
+
+    warn "Calling i3 $args failed. Is DISPLAY set and is i3 in your PATH?";
+    return undef;
+}
+
+=head2 $i3 = AnyEvent::I3->new([ $path ])
+
+Creates a new C<AnyEvent::I3> object and returns it.
+
+C<path> is an optional path of the UNIX socket to connect to. It is strongly
+advised to NOT specify this unless you're absolutely sure you need it.
+C<AnyEvent::I3> will automatically figure it out by querying the running i3
+instance on the current DISPLAY which is almost always what you want.
+
+=cut
+sub new {
+    my ($class, $path) = @_;
+
+    # We have I3SOCK now
+    $path ||= $ENV{I3SOCK};
+    $path ||= _call_i3('--get-socketpath');
+
+    # Check if we need to resolve ~
+    if ($path =~ /~/) {
+        my $home = $ENV{HOME};
+        confess "Could not get home directory" unless $home and -d $home;
+        $path =~ s/~/$home/g;
+    }
+
+    if(!-S $path) {
+        die "$path is not a socket", $/;
+    }
+
+    bless { path => $path } => $class;
+}
+
+=head2 $i3->connect
+
+Establishes the connection to i3. Returns an C<AnyEvent::CondVar> which will
+be triggered with a boolean (true if the connection was established) as soon as
+the connection has been established.
+
+    if ($i3->connect->recv) {
+        say "Connected to i3";
+    }
+
+=cut
+sub connect {
+    my ($self) = @_;
+    my $cv = AnyEvent->condvar;
+
+    tcp_connect "unix/", $self->{path}, sub {
+        my ($fh) = @_;
+
+        return $cv->send(0) unless $fh;
+
+        $self->{ipchdl} = AnyEvent::Handle->new(
+            fh => $fh,
+            on_read => sub { my ($hdl) = @_; $self->_data_available($hdl) },
+            on_error => sub {
+                my ($hdl, $fatal, $msg) = @_;
+                delete $self->{ipchdl};
+                $hdl->destroy;
+
+                my $cb = $self->{callbacks};
+
+                # Trigger all one-time callbacks with undef
+                for my $type (keys %{$cb}) {
+                    next if ($type & $event_mask) == $event_mask;
+                    $cb->{$type}->();
+                    delete $cb->{$type};
+                }
+
+                # Trigger _error callback, if set
+                my $type = $events{_error};
+                return unless defined($cb->{$type});
+                $cb->{$type}->($msg);
+            }
+        );
+
+        $cv->send(1)
+    };
+
+    $cv
+}
+
+sub _data_available {
+    my ($self, $hdl) = @_;
+
+    $hdl->unshift_read(
+        chunk => length($magic) + 4 + 4,
+        sub {
+            my $header = $_[1];
+            # Unpack message length and read the payload
+            my ($len, $type) = unpack("LL", substr($header, length($magic)));
+            $hdl->unshift_read(
+                chunk => $len,
+                sub { $self->_handle_i3_message($type, $_[1]) }
+            );
+        }
+    );
+}
+
+sub _handle_i3_message {
+    my ($self, $type, $payload) = @_;
+
+    return unless defined($self->{callbacks}->{$type});
+
+    my $cb = $self->{callbacks}->{$type};
+    $cb->(decode_json $payload);
+
+    return if ($type & $event_mask) == $event_mask;
+
+    # If this was a one-time callback, we delete it
+    # (when connection is lost, all one-time callbacks get triggered)
+    delete $self->{callbacks}->{$type};
+}
+
+=head2 $i3->subscribe(\%callbacks)
+
+Subscribes to the given event types. This function awaits a hashref with the
+key being the name of the event and the value being a callback.
+
+    my %callbacks = (
+        workspace => sub { say "Workspaces changed" }
+    );
+
+    if ($i3->subscribe(\%callbacks)->recv->{success}) {
+        say "Successfully subscribed";
+    }
+
+The special callback with name C<_error> is called when the connection to i3
+is killed (because of a crash, exit or restart of i3 most likely). You can
+use it to print an appropriate message and exit cleanly or to try to reconnect.
+
+    my %callbacks = (
+        _error => sub {
+            my ($msg) = @_;
+            say "I am sorry. I am so sorry: $msg";
+            exit 1;
+        }
+    );
+
+    $i3->subscribe(\%callbacks)->recv;
+
+=cut
+sub subscribe {
+    my ($self, $callbacks) = @_;
+
+    # Register callbacks for each message type
+    for my $key (keys %{$callbacks}) {
+        if (!exists $events{$key}) {
+            warn "Could not subscribe to event type '$key'." .
+            " Supported events are " . join(" ", sort keys %events), $/;
+            next;
+        }
+        my $type = $events{$key};
+        $self->{callbacks}->{$type} = $callbacks->{$key};
+    }
+
+    $self->message(TYPE_SUBSCRIBE, [ keys %{$callbacks} ])
+}
+
+=head2 $i3->message($type, $content)
+
+Sends a message of the specified C<type> to i3, possibly containing the data
+structure C<content> (or C<content>, encoded as utf8, if C<content> is a
+scalar), if specified.
+
+    my $reply = $i3->message(TYPE_RUN_COMMAND, "reload")->recv;
+    if ($reply->{success}) {
+        say "Configuration successfully reloaded";
+    }
+
+=cut
+sub message {
+    my ($self, $type, $content) = @_;
+
+    confess "No message type specified" unless defined($type);
+
+    confess "No connection to i3" unless defined($self->{ipchdl});
+
+    my $payload = "";
+    if ($content) {
+        if (not ref($content)) {
+            # Convert from Perl’s internal encoding to UTF8 octets
+            $payload = encode_utf8($content);
+        } else {
+            $payload = encode_json $content;
+        }
+    }
+    my $message = $magic . pack("LL", length($payload), $type) . $payload;
+    $self->{ipchdl}->push_write($message);
+
+    my $cv = AnyEvent->condvar;
+
+    # We don’t preserve the old callback as it makes no sense to
+    # have a callback on message reply types (only on events)
+    $self->{callbacks}->{$type} =
+        sub {
+            my ($reply) = @_;
+            $cv->send($reply);
+            undef $self->{callbacks}->{$type};
+        };
+
+    $cv
+}
+
+=head1 SUGAR METHODS
+
+These methods intend to make your scripts as beautiful as possible. All of
+them automatically establish a connection to i3 blockingly (if it does not
+already exist).
+
+=cut
+
+sub _ensure_connection {
+    my ($self) = @_;
+
+    return if defined($self->{ipchdl});
+
+    $self->connect->recv or confess "Unable to connect to i3 (socket path " . $self->{path} . ")";
+}
+
+=head2 get_workspaces
+
+Gets the current workspaces from i3.
+
+    my $ws = i3->get_workspaces->recv;
+    say Dumper($ws);
+
+=cut
+sub get_workspaces {
+    my ($self) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_GET_WORKSPACES)
+}
+
+=head2 get_outputs
+
+Gets the current outputs from i3.
+
+    my $outs = i3->get_outputs->recv;
+    say Dumper($outs);
+
+=cut
+sub get_outputs {
+    my ($self) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_GET_OUTPUTS)
+}
+
+=head2 get_tree
+
+Gets the layout tree from i3 (>= v4.0).
+
+    my $tree = i3->get_tree->recv;
+    say Dumper($tree);
+
+=cut
+sub get_tree {
+    my ($self) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_GET_TREE)
+}
+
+=head2 get_marks
+
+Gets all the window identifier marks from i3 (>= v4.1).
+
+    my $marks = i3->get_marks->recv;
+    say Dumper($marks);
+
+=cut
+sub get_marks {
+    my ($self) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_GET_MARKS)
+}
+
+=head2 get_bar_config
+
+Gets the bar configuration for the specific bar id from i3 (>= v4.1).
+
+    my $config = i3->get_bar_config($id)->recv;
+    say Dumper($config);
+
+=cut
+sub get_bar_config {
+    my ($self, $id) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_GET_BAR_CONFIG, $id)
+}
+
+=head2 get_version
+
+Gets the i3 version via IPC, with a fall-back that parses the output of i3
+--version (for i3 < v4.3).
+
+    my $version = i3->get_version()->recv;
+    say "major: " . $version->{major} . ", minor = " . $version->{minor};
+
+=cut
+sub get_version {
+    my ($self) = @_;
+
+    $self->_ensure_connection;
+
+    my $cv = AnyEvent->condvar;
+
+    my $version_cv = $self->message(TYPE_GET_VERSION);
+    my $timeout;
+    $timeout = AnyEvent->timer(
+        after => 1,
+        cb => sub {
+            warn "Falling back to i3 --version since the running i3 doesn’t support GET_VERSION yet.";
+            my $version = _call_i3('--version');
+            $version =~ s/^i3 version //;
+            my $patch = 0;
+            my ($major, $minor) = ($version =~ /^([0-9]+)\.([0-9]+)/);
+            if ($version =~ /^[0-9]+\.[0-9]+\.([0-9]+)/) {
+                $patch = $1;
+            }
+            # Strip everything from the © sign on.
+            $version =~ s/ ©.*$//g;
+            $cv->send({
+                major => int($major),
+                minor => int($minor),
+                patch => int($patch),
+                human_readable => $version,
+            });
+            undef $timeout;
+        },
+    );
+    $version_cv->cb(sub {
+        undef $timeout;
+        $cv->send($version_cv->recv);
+    });
+
+    return $cv;
+}
+
+=head2 get_config
+
+Gets the raw last read config from i3. Requires i3 >= 4.14
+
+=cut
+sub get_config {
+    my ($self) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_GET_CONFIG);
+}
+
+=head2 send_tick
+
+Sends a tick event. Requires i3 >= 4.15
+
+=cut
+sub send_tick {
+    my ($self, $payload) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_SEND_TICK, $payload);
+}
+
+=head2 sync
+
+Sends an i3 sync event. Requires i3 >= 4.16
+
+=cut
+sub sync {
+    my ($self, $payload) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_SYNC, $payload);
+}
+
+=head2 command($content)
+
+Makes i3 execute the given command
+
+    my $reply = i3->command("reload")->recv;
+    die "command failed" unless $reply->{success};
+
+=cut
+sub command {
+    my ($self, $content) = @_;
+
+    $self->_ensure_connection;
+
+    $self->message(TYPE_RUN_COMMAND, $content)
+}
+
+=head1 AUTHOR
+
+Michael Stapelberg, C<< <michael at i3wm.org> >>
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-anyevent-i3 at
+rt.cpan.org>, or through the web interface at
+L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=AnyEvent-I3>.  I will be
+notified, and then you'll automatically be notified of progress on your bug as
+I make changes.
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+    perldoc AnyEvent::I3
+
+You can also look for information at:
+
+=over 2
+
+=item * RT: CPAN's request tracker
+
+L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=AnyEvent-I3>
+
+=item * The i3 window manager website
+
+L<https://i3wm.org>
+
+=back
+
+
+=head1 ACKNOWLEDGEMENTS
+
+
+=head1 LICENSE AND COPYRIGHT
+
+Copyright 2010-2012 Michael Stapelberg.
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of either: the GNU General Public License as published
+by the Free Software Foundation; or the Artistic License.
+
+See https://dev.perl.org/licenses/ for more information.
+
+
+=cut
+
+1; # End of AnyEvent::I3

AnyEvent-I3/t/00-load.t

@@ -0,0 +1,10 @@
+#!perl
+
+use Test::More tests => 1;
+
+BEGIN {
+    use_ok( 'AnyEvent::I3' ) || print "Bail out!
+";
+}
+
+diag( "Testing AnyEvent::I3 $AnyEvent::I3::VERSION, Perl $], $^X" );

AnyEvent-I3/t/01-workspaces.t

@@ -0,0 +1,29 @@
+#!perl
+# vim:ts=4:sw=4:expandtab
+
+use Test::More tests => 3;
+use AnyEvent::I3;
+use AnyEvent;
+
+my $i3 = i3();
+my $cv = AnyEvent->condvar;
+
+# Try to connect to i3
+$i3->connect->cb(sub { my ($v) = @_; $cv->send($v->recv) });
+
+# But cancel if we are not connected after 0.5 seconds
+my $t = AnyEvent->timer(after => 0.5, cb => sub { $cv->send(0) });
+my $connected = $cv->recv;
+
+SKIP: {
+    skip 'No connection to i3', 3 unless $connected;
+
+    my $workspaces = $i3->message(1)->recv;
+    isa_ok($workspaces, 'ARRAY');
+
+    ok(@{$workspaces} > 0, 'More than zero workspaces found');
+
+    ok(defined(@{$workspaces}[0]->{num}), 'JSON deserialized');
+}
+
+diag( "Testing AnyEvent::I3 $AnyEvent::I3::VERSION, Perl $], $^X" );

AnyEvent-I3/t/02-sugar.t

@@ -0,0 +1,29 @@
+#!perl
+# vim:ts=4:sw=4:expandtab
+
+use Test::More tests => 3;
+use AnyEvent::I3;
+use AnyEvent;
+
+my $i3 = i3();
+my $cv = AnyEvent->condvar;
+
+# Try to connect to i3
+$i3->connect->cb(sub { my ($v) = @_; $cv->send($v->recv) });
+
+# But cancel if we are not connected after 0.5 seconds
+my $t = AnyEvent->timer(after => 0.5, cb => sub { $cv->send(0) });
+my $connected = $cv->recv;
+
+SKIP: {
+    skip 'No connection to i3', 3 unless $connected;
+
+    my $workspaces = i3->get_workspaces->recv;
+    isa_ok($workspaces, 'ARRAY');
+
+    ok(@{$workspaces} > 0, 'More than zero workspaces found');
+
+    ok(defined(@{$workspaces}[0]->{num}), 'JSON deserialized');
+}
+
+diag( "Testing AnyEvent::I3 $AnyEvent::I3::VERSION, Perl $], $^X" );

AnyEvent-I3/t/boilerplate.t

@@ -0,0 +1,55 @@
+#!perl
+
+use strict;
+use warnings;
+use Test::More tests => 3;
+
+sub not_in_file_ok {
+    my ($filename, %regex) = @_;
+    open( my $fh, '<', $filename )
+        or die "couldn't open $filename for reading: $!";
+
+    my %violated;
+
+    while (my $line = <$fh>) {
+        while (my ($desc, $regex) = each %regex) {
+            if ($line =~ $regex) {
+                push @{$violated{$desc}||=[]}, $.;
+            }
+        }
+    }
+
+    if (%violated) {
+        fail("$filename contains boilerplate text");
+        diag "$_ appears on lines @{$violated{$_}}" for keys %violated;
+    } else {
+        pass("$filename contains no boilerplate text");
+    }
+}
+
+sub module_boilerplate_ok {
+    my ($module) = @_;
+    not_in_file_ok($module =>
+        'the great new $MODULENAME'   => qr/ - The great new /,
+        'boilerplate description'     => qr/Quick summary of what the module/,
+        'stub function definition'    => qr/function[12]/,
+    );
+}
+
+TODO: {
+  local $TODO = "Need to replace the boilerplate text";
+
+  not_in_file_ok(README =>
+    "The README is used..."       => qr/The README is used/,
+    "'version information here'"  => qr/to provide version information/,
+  );
+
+  not_in_file_ok(Changes =>
+    "placeholder date/time"       => qr(Date/time)
+  );
+
+  module_boilerplate_ok('lib/AnyEvent/I3.pm');
+
+
+}
+

AnyEvent-I3/t/manifest.t

@@ -0,0 +1,13 @@
+#!perl
+
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+    plan( skip_all => "Author tests not required for installation" );
+}
+
+eval "use Test::CheckManifest 0.9";
+plan skip_all => "Test::CheckManifest 0.9 required" if $@;
+ok_manifest();

AnyEvent-I3/t/pod-coverage.t

@@ -0,0 +1,18 @@
+use strict;
+use warnings;
+use Test::More;
+
+# Ensure a recent version of Test::Pod::Coverage
+my $min_tpc = 1.08;
+eval "use Test::Pod::Coverage $min_tpc";
+plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage"
+    if $@;
+
+# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version,
+# but older versions don't recognize some common documentation styles
+my $min_pc = 0.18;
+eval "use Pod::Coverage $min_pc";
+plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage"
+    if $@;
+
+all_pod_coverage_ok();

AnyEvent-I3/t/pod.t

@@ -0,0 +1,12 @@
+#!perl
+
+use strict;
+use warnings;
+use Test::More;
+
+# Ensure a recent version of Test::Pod
+my $min_tp = 1.22;
+eval "use Test::Pod $min_tp";
+plan skip_all => "Test::Pod $min_tp required for testing POD" if $@;
+
+all_pod_files_ok();

DEPENDS

@@ -4,31 +4,41 @@
    "min" means minimum required version
    "lkgv" means last known good version
 
-┌─────────────┬────────┬────────┬────────────────────────────────────────┐
-│ dependency  │ min.   │ lkgv   │ URL                                    │
-├─────────────┼────────┼────────┼────────────────────────────────────────┤
-│ pkg-config  │ 0.25   │ 0.26   │ http://pkgconfig.freedesktop.org/      │
-│ libxcb      │ 1.1.93 │ 1.7    │ http://xcb.freedesktop.org/dist/       │
-│ xcb-util    │ 0.3.3  │ 0.3.8  │ http://xcb.freedesktop.org/dist/       │
-│ libev       │ 4.0    │ 4.11   │ http://libev.schmorp.de/               │
-│ yajl        │ 1.0.8  │ 2.0.1  │ http://lloyd.github.com/yajl/          │
-│ asciidoc    │ 8.3.0  │ 8.6.4  │ http://www.methods.co.nz/asciidoc/     │
-│ xmlto       │ 0.0.23 │ 0.0.23 │ http://www.methods.co.nz/asciidoc/     │
-│ Pod::Simple²│ 3.22   │ 3.22   │ http://search.cpan.org/~dwheeler/Pod-Simple-3.23/
-│ docbook-xml │ 4.5    │ 4.5    │ http://www.methods.co.nz/asciidoc/     │
-│ libxcursor  │ 1.1.11 │ 1.1.11 │ http://ftp.x.org/pub/current/src/lib/  │
-│ Xlib        │ 1.3.3  │ 1.4.3  │ http://ftp.x.org/pub/current/src/lib/  │
-│ PCRE        │ 8.12   │ 8.12   │ http://www.pcre.org/                   │
-│ libsn¹      │ 0.10   │ 0.12   │ http://freedesktop.org/wiki/Software/startup-notification
-│ pango       │ 1.30.0 | 1.30.0 │ http://www.pango.org/                  │
-│ cairo       │ 1.12.2 │ 1.12.2 │ http://cairographics.org/              │
-└─────────────┴────────┴────────┴────────────────────────────────────────┘
+┌──────────────┬────────┬────────┬─────────────────────────────────────────────────────────────┐
+│ dependency   │ min.   │ lkgv   │ URL                                                         │
+├──────────────┼────────┼────────┼─────────────────────────────────────────────────────────────┤
+│ pkg-config   │ 0.25   │ 0.29   │ https://pkgconfig.freedesktop.org/                          │
+│ libxcb       │ 1.1.93 │ 1.12   │ https://xcb.freedesktop.org/dist/                           │
+│ xcb-util     │ 0.3.3  │ 0.4.1  │ https://xcb.freedesktop.org/dist/                           │
+│ xkbcommon    │ 0.4.0  │ 0.6.1  │ https://xkbcommon.org/                                      │
+│ xkbcommon-x11│ 0.4.0  │ 0.6.1  │ https://xkbcommon.org/                                      │
+│ util-cursor³⁴│ 0.0.99 │ 0.1.3  │ https://xcb.freedesktop.org/dist/                           │
+│ util-wm⁴     │ 0.3.8  │ 0.3.8  │ https://xcb.freedesktop.org/dist/                           │
+│ util-keysyms⁴│ 0.3.8  │ 0.4.0  │ https://xcb.freedesktop.org/dist/                           │
+│ util-xrm⁴    │ 1.0.0  │ 1.0.0  │ https://github.com/Airblader/xcb-util-xrm/                  │
+│ libev        │ 4.0    │ 4.19   │ http://libev.schmorp.de/                                    │
+│ yajl         │ 2.0.1  │ 2.1.0  │ https://lloyd.github.com/yajl/                              │
+│ asciidoc     │ 8.3.0  │ 8.6.9  │ http://www.methods.co.nz/asciidoc/                          │
+│ xmlto        │ 0.0.23 │ 0.0.23 │ http://www.methods.co.nz/asciidoc/                          │
+│ Pod::Simple² │ 3.22   │ 3.22   │ http://search.cpan.org/dist/Pod-Simple/                     │
+│ docbook-xml  │ 4.5    │ 4.5    │ http://www.methods.co.nz/asciidoc/                          │
+│ PCRE         │ 8.12   │ 8.38   │ https://www.pcre.org/                                       │
+│ libsn¹       │ 0.10   │ 0.12   │ https://freedesktop.org/wiki/Software/startup-notification/ │
+│ pango        │ 1.30.0 │ 1.40.1 │ http://www.pango.org/                                       │
+│ cairo        │ 1.14.4 │ 1.14.6 │ https://cairographics.org/                                  │
+└──────────────┴────────┴────────┴─────────────────────────────────────────────────────────────┘
  ¹ libsn = libstartup-notification
  ² Pod::Simple is a Perl module required for converting the testsuite
-   documentation to HTML. See http://michael.stapelberg.de/cpan/#Pod::Simple
+   documentation to HTML. See https://michael.stapelberg.de/cpan/#Pod::Simple
+ ³ xcb-util-cursor, to be precise.
+ ⁴ Depending on your distribution, this might be considered part of xcb-util.
 
  i3bar, i3-msg, i3-input, i3-nagbar and i3-config-wizard do not introduce any
  new dependencies.
 
- i3-migrate-config-to-v4 is implemented in Perl, but it has no dependencies
- besides Perl 5.10.
+ i3-migrate-config-to-v4 and i3-dmenu-desktop are implemented in Perl, but have
+ no dependencies besides Perl 5.10.
+
+ i3-save-tree is also implemented in Perl and needs AnyEvent::I3 (>= 0.12) and
+ JSON::XS. While i3-save-tree is not required for running i3 itself, it is
+ strongly recommended to provide it in distribution packages.

I3_VERSION

@@ -0,0 +1 @@
+4.19.1-non-git

LICENSE

@@ -1,27 +1,26 @@
-Copyright © 2009-2011, Michael Stapelberg and contributors
-All rights reserved.
+Copyright © 2009, Michael Stapelberg and contributors
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+modification, are permitted provided that the following conditions
+are met:
 
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
 
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-
-    * Neither the name of Michael Stapelberg nor the
-      names of contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY Michael Stapelberg ''AS IS'' AND ANY
-EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL Michael Stapelberg BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -1,62 +0,0 @@
-TOPDIR=$(shell pwd)
-
-include $(TOPDIR)/common.mk
-
-SUBDIRS:=
-
-ALL_TARGETS =
-INSTALL_TARGETS =
-CLEAN_TARGETS =
-DISTCLEAN_TARGETS =
-
-all: real-all
-
-include libi3/libi3.mk
-include src/i3.mk
-include i3-config-wizard/i3-config-wizard.mk
-include i3-msg/i3-msg.mk
-include i3-input/i3-input.mk
-include i3-nagbar/i3-nagbar.mk
-include i3bar/i3bar.mk
-include i3-dump-log/i3-dump-log.mk
-include docs/docs.mk
-include man/man.mk
-
-real-all: $(ALL_TARGETS)
-
-install: $(INSTALL_TARGETS)
-
-dist: distclean
-	[ ! -d i3-${VERSION} ] || rm -rf i3-${VERSION}
-	[ ! -e i3-${VERSION}.tar.bz2 ] || rm i3-${VERSION}.tar.bz2
-	mkdir i3-${VERSION}
-	cp i3-migrate-config-to-v4 generate-command-parser.pl i3-sensible-* i3-dmenu-desktop i3.config.keycodes DEPENDS LICENSE PACKAGE-MAINTAINER RELEASE-NOTES-${VERSION} i3.config i3.xsession.desktop i3.applications.desktop pseudo-doc.doxygen common.mk Makefile i3-${VERSION}
-	cp -r src libi3 i3-msg i3-nagbar i3-config-wizard i3bar i3-dump-log yajl-fallback include man parser-specs testcases i3-${VERSION}
-	# Only copy toplevel documentation (important stuff)
-	mkdir i3-${VERSION}/docs
-	# Pre-generate documentation
-	$(MAKE) docs
-	# Cleanup τεχ output files
-	find docs -regex ".*\.\(aux\|out\|log\|toc\|bm\|dvi\|log\)" -exec rm '{}' \;
-	find docs -maxdepth 1 -type f ! \( -name "*.xcf" -or -name "*.svg" \) -exec cp '{}' i3-${VERSION}/docs \;
-	# Only copy source code from i3-input
-	mkdir i3-${VERSION}/i3-input
-	find i3-input -maxdepth 1 -type f \( -name "*.c" -or -name "*.mk" -or -name "*.h" -or -name "Makefile" \) -exec cp '{}' i3-${VERSION}/i3-input \;
-	echo -n ${I3_VERSION} > i3-${VERSION}/I3_VERSION
-	echo -n ${VERSION} > i3-${VERSION}/VERSION
-	# Pre-generate a manpage to allow distributors to skip this step and save some dependencies
-	$(MAKE) mans
-	cp man/*.1 i3-${VERSION}/man/
-	tar cfj i3-${VERSION}.tar.bz2 i3-${VERSION}
-	rm -rf i3-${VERSION}
-
-clean: $(CLEAN_TARGETS)
-	(which lcov >/dev/null 2>&1 && lcov -d . --zerocounters) || true
-
-distclean: clean $(DISTCLEAN_TARGETS)
-
-coverage:
-	rm -f /tmp/i3-coverage.info
-	rm -rf /tmp/i3-coverage
-	lcov -d . -b . --capture -o /tmp/i3-coverage.info
-	genhtml -o /tmp/i3-coverage/ /tmp/i3-coverage.info

PACKAGE-MAINTAINER

@@ -21,16 +21,14 @@ i3-sensible-terminal is used in the default configuration.
 If your distribution has a mechanism to get the preferred terminal, such as the
 x-terminal-emulator symlink in Debian, please use it in i3-sensible-terminal.
 
-On debian, compilation and installing the manpages looks like this:
+You can build i3 like you build any other software package which uses
+https://mesonbuild.com/; see
+https://mesonbuild.com/Quick-guide.html#compiling-a-meson-project
+In case you’re unfamiliar:
 
-	# Compilation
-	$(MAKE)
-	$(MAKE) -C man
-
-	# Installation
-	$(MAKE) DESTDIR=$(CURDIR)/debian/i3-wm/ install
-	mkdir -p $(CURDIR)/debian/i3-wm/usr/share/man/man1
-	cp man/*.1 $(CURDIR)/debian/i3-wm/usr/share/man/man1
+    $ mkdir -p build && cd build
+    $ meson setup
+    $ ninja
 
 Please make sure that i3-migrate-config-to-v4 and i3-config-wizard are
 installed with i3. The Perl script is necessary to (automatically) convert v3
@@ -39,10 +37,8 @@ config with the user’s preferred modifier and should be started on the first
 start of i3 (it will automatically exit if it finds a config file).
 
 If you have any questions, ideas, hints, problems or whatever, please do not
-hesitate to contact me. I will help you out. Just drop me an E-Mail (find the
-address at http://michael.stapelberg.de/Kontakt, scroll down to bottom),
-contact me using the same address in jabber or ask on our IRC channel:
-(#i3 on irc.twice-irc.de).
+hesitate to contact me. I will help you out. Please see
+https://i3wm.org/contact/
 
 Thanks again for your efforts,
 Michael

README.md

@@ -0,0 +1,15 @@
+![Logo](docs/logo-30.png) i3: A tiling window manager
+=====================================================
+
+[![Build Status](https://github.com/i3/i3/actions/workflows/main.yml/badge.svg)](https://github.com/i3/i3/actions/workflows/main.yml)
+[![Issue Stats](https://img.shields.io/github/issues/i3/i3.svg)](https://github.com/i3/i3/issues)
+[![Pull Request Stats](https://img.shields.io/github/issues-pr/i3/i3.svg)](https://github.com/i3/i3/pulls)
+
+[![Packages](https://repology.org/badge/latest-versions/i3.svg)](https://repology.org/metapackage/i3/versions)
+[![Packages](https://repology.org/badge/tiny-repos/i3.svg)](https://repology.org/metapackage/i3/versions)
+
+i3 is a tiling window manager for X11.
+
+For more information about i3, please see [the project's website](https://i3wm.org/) and [online documentation](https://i3wm.org/docs/).
+
+For information about contributing to i3, please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).

RELEASE-NOTES-4.2

@@ -1,100 +0,0 @@
-
- ┌──────────────────────────────┐
- │ Release notes for i3 v4.2    │
- └──────────────────────────────┘
-
-This is the second release of the new major version of i3, v4.2. It is
-considered stable. All users of i3 are strongly encouraged to upgrade.
-
-A big change with this release is (again) a new parser for commands. You might
-get the impression that we like rewriting parsers, but check the commit message
-of commit a532f5a for rationale on this decision.
-
-A more visible change to users is the introduction of a scratchpad command:
-This is useful to have a permanent editor session ready whenever you need it.
-Or your music player. Or email client? Or $programming-language REPL? Give it a
-try!
-
-Also, you are finally able to move workspaces between the different outputs if
-you are using multiple monitors. You can rename workspaces on the fly and
-identify named workspaces by their number. So you can rename "1: www" to "1:
-code" with one simple rename command and all your keybindings will still work.
-
-A subtle indicator of the split state of containers has been introduced: In
-case you are in a split container with precisely one window (a situation which
-you could not recognize by looking at your screen previously), i3 will
-highlight the bottom/right border of the split container in a lighter blue.
-This should reduce confusion about whether you are dealing with a split
-container or not.
-
-And finally, i3bar now supports a JSON input protocol, so that with a
-subsequent release of i3status, you will be able to use colors in your bar!
-
- ┌────────────────────────────┐
- │ Changes in v4.2            │
- └────────────────────────────┘
-
-  • i3-sensible-*: don’t call which without parameters
-  • i3-config-wizard: Mark the currently selected modifier with an arrow
-  • i3bar: kick tray clients after output configuration changed
-  • i3bar: kill child processes when exit()ing (they might be stopped)
-  • i3bar now supports a JSON input format to provide colors and more (later)
-  • Support different modifier keys for showing i3bar in hide mode
-  • bar config: add i3bar_command for non-standard setups
-  • Implement scratchpad functionality
-  • Implement 'focus output left|right|up|down'
-  • Implement 'workspace next_on_output|prev_on_output'
-  • Implement 'move workspace to output <output>'
-  • Implement a new parser for commands
-  • Implement 'workspace number <number>' to switch to named workspaces
-  • Implement 'move [container|window] to workspace number <number>'
-  • Implement 'rename workspace <old_name> to <new_name>'
-  • Re-implement borders in the workspace bar
-  • Draw a separator line after each tab in tabbed mode
-  • Ignore aspect ratio during fullscreen mode (fixes MPlayer subtitles)
-  • Correctly restore focus after in-place restarts
-  • Highlight the right/bottom border of split windows ("indicator")
-  • Install /usr/share/applications/i3.desktop so that you can select i3 as a
-    window manager in GNOME
-  • Don’t migrate unfocused empty workspaces when disabling an output
-  • randr: Skip workspaces which are assigned to a different output when
-    creating a new workspace
-  • Implement an urgency flag criterion
-  • Render only once for all matching assignments
-  • Implement support for user configuration of constraints on floating window
-    dimensions
-  • Extend move command for floating windows
-  • Added option to select primary display on tray_output
-  • Implement resize <grow|shrink> <width|height>, use it in the default config
-  • Replace the old fullscreen container when requesting fullscreen
-  • Prevent changing focus outside a container when scrolling on the
-    decorations
-  • Only resize when the left/right mouse button is used, not when scrolling
-  • docs: replace the refcard with an HTML version
-  • cfgparse: accept force-xinerama as a synonym of force_xinerama
-  • Implement support for 32 bit visuals (necessary for transparency)
-  • X11: only copy the requested region from buffer pixmaps in ExposeEvents
-
- ┌────────────────────────────┐
- │ Bugfixes                   │
- └────────────────────────────┘
-
-  • Bugfix: Don’t leak IPC file descriptors
-  • Bugfix: fix empty tray icon areas in i3bar
-  • Bugfix: properly handle workspace names with double quotes
-
- ┌────────────────────────────┐
- │ Thanks!                    │
- └────────────────────────────┘
-
-Thanks for testing, bugfixes, discussions and everything I forgot go out to:
-
-  Aaron Small, ablepharus, aksr, alexander, badboy, B-con, beauby, ben, biiter,
-  binzter, cg, cradle, darkraven, dbp, dcoppa, Don, dothebart, D Thompson,
-  eeemsi, f8l, Fandekasp, fernandotcl, gamo, garga, gregkh, Han, helgikrs,
-  Jeremy O'Brien, jjfoerch, joepd, Jose Pereira, Jure Ziberna, MasterofJOKers,
-  Merovius, mhcerri, migueldvb, moemoe, mseed, mxf, nh2, noxxun, Paul, Pavel
-  Löbl, Peter Bui, Phlogistique, phnom, piroko, rami, SardemFF7, xeen, xpt,
-  zeus
-
--- Michael Stapelberg, 2012-04-25

RELEASE-NOTES-4.24

@@ -0,0 +1,62 @@
+
+ ┌──────────────────────────────┐
+ │ Release notes for i3 v4.24   │
+ └──────────────────────────────┘
+
+This is i3 v4.24. This version is considered stable. All users of i3 are
+strongly encouraged to upgrade.
+
+Aside from a number of bug fixes and detail improvements, the tiling drag
+feature has been extended to allow swapping containers with the mouse.
+See the swap_modifier in the userguide: 
+https://i3wm.org/docs/userguide.html
+
+ ┌────────────────────────────┐
+ │ Changes in i3 v4.24        │
+ └────────────────────────────┘
+
+  • docs/userguide: add note to default_border about title bar in stacked/tabbed
+  • docs/userguide: fix focus output next example
+  • docs/hacking-howto: update build instructions
+  • docs/testsuite: update instructions
+  • docs/ipc: update section on IPC socket location
+  • docs/ipc: describe workspace events in more detail
+  • i3-sensible-terminal: add rio
+  • i3bar: use short-form text on a per-block basis
+  • reap zombie children when starting
+  • do not grab mouse pointer when executing bindings
+  • tiling drag: swap containers with the mouse
+  • disable automatic v3-to-v4 migration script
+  • pass _NET_WM_STATE_MAXIMIZED_{HORZ, VERT} (fixes tab bar in Google Chrome)
+  • avoid creating redundant containers when switching between layouts
+  • deprecate smart_borders in favour of hide_edge_borders smart/smart_no_gaps
+  • float windows of type _NET_WM_WINDOW_TYPE_NOTIFICATION by default
+  • add “popup_during_fullscreen all”
+  • mark fullscreen windows as maximized
+  • support multiple _NET_WM_STATE changes in one ClientMessage
+  • fix size_t format specifiers on 32-bit systems
+
+ ┌────────────────────────────┐
+ │ Bugfixes                   │
+ └────────────────────────────┘
+
+  • i3bar: fix clicks when horizontal padding is used
+  • consider workspace_auto_back_and_forth in focus workspace
+  • workspace next/prev: do not skip identically numbered workspaces
+  • make order of numbered workspace consistent with non-numbered
+  • fix crash with focus output and command criteria matching scratchpad window
+  • fix crash when reloading config with invalid criteria
+  • fix error log related crash
+
+ ┌────────────────────────────┐
+ │ Thanks!                    │
+ └────────────────────────────┘
+
+Thanks for testing, bugfixes, discussions and everything I forgot go out to:
+
+  a-kenji, Alessandro Vinciguerra, Bimba Laszlo, colona_, Eddie Lebow, Harimbola
+  Santatra, Junicchi, Malix, Nikolay Nechaev, Orestis Floros, rsgowman,
+  sethpollen, Seth Pollen, systec-awe, Tasos Sahanidis, Theo Buehler, Wesley
+  Schwengle, Yonas Yanfa, yuvallangerontheroad
+
+-- Michael Stapelberg, 2024-11-06

RELEASE-NOTES-4.3

@@ -1,186 +0,0 @@
-
- ┌──────────────────────────────┐
- │ Release notes for i3 v4.3    │
- └──────────────────────────────┘
-
-This is the i3 v4.3. This version is considered stable. All users of i3 are
-strongly encouraged to upgrade.
-
-One rather visible change is that commands which could not be parsed properly
-  will now spawn i3-nagbar. In case you used "bindsym $mod+x firefox" (and
-  forgot the "exec" keyword) or you made a typo in your config, you will now
-  notice that :).
-
-
-We also made the orientation (horizontal/vertical) part of the layout
-  mechanism: Before, we got the default layout and you could change
-  orientation. Now, there are two new layouts "splitv" and "splith", which
-  replace the default layout. The "split h" and "split v" commands continue to
-  work as before, they split the current container and you will end up in a
-  split container with layout splith (after "split h") or splitv (after
-  "split v").
-
-  To change a splith container into a splitv container, use either "layout
-  splitv" or "layout toggle split". The latter command is used in the
-  default config as mod+e (formerly "layout default"). In case you have
-  "layout default" in your config file, it is recommended to just replace
-  it by "layout toggle split", which will work as "layout default" did
-  before when pressing it once, but toggle between horizontal/vertical
-  when pressing it repeatedly.
-
-  The rationale behind this change is that it’s cleaner to have all
-  parameters that influence how windows are rendered in the layout itself
-  rather than having one special layout in combination with an additional
-  orientation. This enables us to change existing split containers in all
-  cases without breaking existing features (see ticket #464). Also, users
-  should feel more confident about whether they are actually splitting or
-  just changing an existing split container now.
-
-  As a nice side-effect, this commit brings back the "layout toggle"
-  feature we once had in i3 v3 (see the userguide).
-
-
-Another very important change is that we now support pango for rendering text.
-  The default is still to use misc-fixed (X core fonts), but you can use a font
-  specification starting with "xft:" now, such as "xft:DejaVu Sans Mono 10" and
-  i3 will use pango. The sole motivation for this is NOT to have fancier window
-  decorations, but to support fonts which have more glyphs (think Japanese for
-  example) and to support right-to-left rendering (open http://www.ftpal.net/
-  for an example). Supporting users from all over the planet is important, and
-  as such I would strongly advise distribution packagers to leave pango support
-  enabled. In case you are working on a very low-spec embedded device, it is
-  easy enough to disable pango support, see common.mk.
-
-
-Also, the 'layout' command now always works on the parent split container. This
-  allows you to do things like this:
-
-      for_window [class="XTerm"] layout tabbed
-
-  When you now open XTerm on an empty workspace, the whole workspace will be
-  set to tabbed. In case you want to open XTerm in its own tabbed split
-  container, you need to split before:
-
-      for_window [class="XTerm"] split v, layout tabbed
-
-
-Furthermore, we decided to entirely ignore resize increment size hints for
-  tiling windows. These are set by terminal emulators (such as urxvt,
-  gnome-terminal, …) and specify that the window may only be resized in
-  multiples of the specified size. All terminal emulators cope with the window
-  manager ignoring these hints and by doing so, they can decide what to do with
-  the lost space (that is, pseudo-transparency now works without black bars in
-  urxvt).
-
- ┌────────────────────────────┐
- │ Changes in v4.3            │
- └────────────────────────────┘
-
-  • docs: there now is documentation about lib::i3test and lib::i3test::Test,
-    the main Perl modules used by our testsuite.
-  • docs/refcard: update for v4
-  • docs/userguide: clarify the default for focus_follows_mouse and new_window
-  • docs/userguide: add section about implicit containers
-  • docs/userguide: give 'move <container|workspace> to output' its own section
-  • docs/ipc: document the 'window' field in the GET_TREE reply
-  • docs/ipc: update links to ipc libraries
-  • docs/ipc: make the reply sections consistent
-  • docs/i3bar-protocol: add example (illustration-only!) shell script
-  • man/i3bar.man: reference i3bar-protocol
-  • IPC: Commands now lead to proper error messages in general. If we forgot
-    about a specific one, please open a ticket.
-  • IPC: implement GET_VERSION to find out the i3 version
-  • i3-dump-log now comes with a massively more helpful error message that
-    should cover all the use cases.
-  • 'workspace number <number>' now opens a new workspace
-  • 'workspace number <number>' now works with the back_and_forth option
-  • Allow focus with target (criteria) when in fullscreen mode in some cases
-  • Allow focus child/parent when in fullscreen mode
-  • Restrict directional focus when in fullscreen mode
-  • Prevent moving out of fullscreen containers
-  • Add 'move to workspace current' (useful when used with criteria)
-  • replace loglevels by a global debug logging
-  • make: new makefile layout
-  • make: canonicalize path when compiling. This leads to sth like
-    ../i3-4.2/src/main.c in backtraces, clearly identifying i3 code.
-  • automatically hide i3bar when it’s unneeded (after urgency hints)
-  • i3-config-wizard: use the level 0 keysym whenever it’s unambiguous
-  • i3-nagbar: use custom scripts to work around different terminal emulators
-    using different ways of interpreting the arguments to -e
-  • i3-sensible-terminal: add xfce4-terminal
-  • default config: require confirmation when exiting i3
-  • Display i3-nagbar when a command leads to an error.
-  • testcases: complete-run now supports --xtrace
-  • testcases: handle EAGAIN (fixes hangs)
-  • testcases: handle test bailouts
-  • Introduce splith/splitv layouts, remove orientation
-  • Implement hide_edge_borders option
-  • Support _NET_ACTIVE_WINDOW ClientMessages
-  • Set I3_PID atom on the X11 root window
-  • Implement i3 --moreversion, handy for figuring out whether you run the
-    latest binary which is installed.
-  • i3bar: be less strict about the {"version":1} JSON header
-  • shm-logging: implement i3-dump-log -f (follow)
-  • Implement pango support
-  • 'move workspace number n' will now create the workspace if it doesn’t exist
-  • Accept slashes in RandR output names
-  • Keep startup-notification sequences around for 30s after completion
-  • Introduce bindsym --release, which will trigger the binding not on the
-    KeyPress event, but on the KeyRelease event (useful for import(1) or
-    xdotool(1)).
-  • The signalhandler does not offer you to exit i3 anymore. Instead, there is
-    'b' for writing a backtrace to a file in /tmp (if gdb is installed)
-  • Remove support for resize increment hints for tiling windows
-  • Exit fullscreen mode when 'scratchpad show' is executed while in fullscreen
-
- ┌────────────────────────────┐
- │ Bugfixes                   │
- └────────────────────────────┘
-
-  • Fix floating precision bug when floating windows are moved between outputs.
-  • i3bar won’t crash when full_text is missing or null in the JSON input
-  • When having "workspace number 1" in your config, there will no longer be a
-    stray workspace "number 1".
-  • i3.config.keycodes used bindsym instead of bindcode for the arrow key
-    resizing bindings by mistake
-  • Fix 'move to workspace' when used with criteria
-  • Handle clicks to the very left edge of i3bar
-  • When using i3 -C, don’t send remaining arguments as an IPC command
-  • Fix reload crashes in rare cases
-  • i3bar: inform all clients of new tray selection owner (fixes tray problems
-    with X-Chat and possibly others)
-  • resizing: traverse containers up properly (fixes non-working resizing when
-    having a h-split within a h-split for example)
-  • Fix floating coordinates when moving assigned workspaces
-  • Properly fix floating coordinates when disabling outputs
-  • floating_fix_coordinates: properly deal with negative positions
-  • floating windows: add deco_height only when in normal border mode (fixes
-    initial floating window position/size when using a different default border
-    setting).
-  • Fix moving scratchpad window
-  • Cleanup zero-byte logfile on immediate exit (they are created by i3
-    --get-socketpath for example).
-  • Fix resizing floating windows by height
-  • Fix back_and_forth in 'workspace number' for named workspaces
-  • Grab server and process pending events before managing existing windows
-    (fixes problems with GIMP windows not being managed after an in-place
-     restart)
-  • Don’t allow ConfigureRequests while in fullscreen (fixes a compatibility
-    issue with gnome-terminal and xfce’s terminal)
-  • Fix flickering with 1pixel border tabbed layouts
-  • Use _exit() instead of exit() when i3 utility programs cannot be executed
-  • Don’t focus the wrong workspace when moving to scratchpad
-
- ┌────────────────────────────┐
- │ Thanks!                    │
- └────────────────────────────┘
-
-Thanks for testing, bugfixes, discussions and everything I forgot go out to:
-
-  aksr, Axel Wagner, darkraven, David Coppa, eeemsi, Felicitus, Fernando Tarlá
-  Cardoso Lemos, Iakov Davydov, jh, Joel Stemmer, Julius Plenz, loblik, Marcel
-  Hellwig, Marcus, mloskot, Moritz Bandemer, oblique, Ondrej Grover, Pavel
-  Löbl, Philipp Middendorf, prg, Quentin Glidic, Sebastian Ullrich, Simon
-  Elsbrock, somelauw, stfn, tucos, TunnelWicht, Valentin Haenel
-
--- Michael Stapelberg, 2012-09-19

RELEASE-NOTES-4.4

@@ -1,107 +0,0 @@
-
- ┌──────────────────────────────┐
- │ Release notes for i3 v4.4    │
- └──────────────────────────────┘
-
-This is the i3 v4.4. This version is considered stable. All users of i3 are
-strongly encouraged to upgrade.
-
-An important under-the-hood change is that we now use the same parser
-  infrastructure for the configuration file as we do for the commands. This
-  makes maintenance and contributions easier and lets us finally escape the
-  insanity that is bison/flex.
-
-  In case there is a bug and your existing config does not work as expected
-  anymore, try using the --force-old-config-parser-v4.4-only flag when starting
-  i3 and please report a bug. This option will only be present in v4.4, so if
-  you don’t report a bug, you are willingly breaking your own config file.
-
-Apart from that, there have been several little fixes and additions which make
-  i3 pay more attention to detail, particularly in the floating window area of
-  the code. See the changes/bugfixes list for more information.
-
- ┌────────────────────────────┐
- │ Changes in v4.4            │
- └────────────────────────────┘
-
-  • add i3-dmenu-desktop, a dmenu wrapper which parses application .desktop
-    files and executes them.
-  • also use a custom parser for the config file
-  • i3.xsession.desktop is now standards-compliant
-  • ipc: you can now subscribe to an event called 'mode' (for binding modes)
-  • implement "move container to workspace back_and_forth"
-  • implement delayed urgency hint reset
-  • make "move workspace number" accept a default workspace name after the
-    number
-  • i3bar: allow child to specify start/stop signals to use in hide mode
-  • i3bar: add "urgent" to protocol, it unhides i3bar when in hide mode
-  • make parent of urgent containers also urgent
-  • add descriptive title to split containers (no more "another container")
-  • click to focus: clicking the root window focuses the relevant workspace
-  • display appropriate cursors when resizing or moving floating windows
-  • implement variable border widths for pixel/normal
-  • Implement moving workspaces as if they’re regular containers
-  • Maintain relative positioning when moving floating windows between outputs
-  • Focus the relevant workspace when clicking any container
-  • docs/ipc: remove unnecessary newline
-  • docs/ipc: add a warning to use an existing library
-  • shmlog: remove O_TRUNC flag for shm_open, we truncate on our own
-  • un-fullscreen as needed when moving fullscreen containers
-  • improve startup sequence termination conditions
-  • allow floating cons to be reached using 'focus parent'
-  • grab keys with all permutations of lock and numlock
-  • allow workspace contents to be moved if there are only floating children
-  • allow 'focus <direction>' to move out of non-global fullscreen containers
-  • exit with a proper error message when there are no outputs available
-  • skip floating cons in focus <child|parent> and stop them from being split
-  • focus windows when middle-clicking
-  • skip floating windows in the focus stack when moving through the tree
-  • docs/userguide: use $mod consistently
-  • keycode default config: s/bindcode/bindsym/
-  • implement smart popup_during_fullscreen mode
-  • docs/testsuite: add "installing the dependencies" section
-  • introduce new command to rename focused workspace
-  • libi3: use "pango:" prefix instead of "xft:" to avoid confusion
-  • ipc: add "current" and "old" containers to workspace events
-  • i3bar: add current binding mode indicator
-  • resizing floating windows now obeys the minimum/maximum size
-  • docs/userguide: document new_float option
-
- ┌────────────────────────────┐
- │ Bugfixes                   │
- └────────────────────────────┘
-
-  • Bugfix: get_output_next() now works with non-aligned RandR setups
-  • Bugfix: close empty workspaces after cross-output move
-  • Bugfix: fix bottom line of tabbed decoration not continuous
-  • Bugfix: use correct coordinates for windows which are opened on a newly
-    created workspace due to assignments
-  • Bugfix: properly react to windows being unmapped before we can reparent
-  • Bugfix: send non-floating window with floating parent to scratchpad
-  • docs/userguide: document how to "un-scratchpad" a window
-  • Bugfix: don’t crash when dragged floating window closes
-  • Bugfix: draw h-split indicator at the correct position
-  • make the resize command honor criteria
-  • Bugfix: with one ws per output, don’t crash on cross-output moves
-  • Bugfix: correctly move floating windows to invisible workspaces
-    cross-output
-  • Bugfix: set workspace_layout in create_workspace_on_output
-  • fix fullscreen focus bug and corresponding test flaw
-  • i3bar: bugfix: don’t send workspace command when at beginning/end of workspace
-  • Bugfix: force rendering when the parent’s orientation changed
-  • Bugfix: fix workspace back_and_forth after displaying a scratchpad window
-
- ┌────────────────────────────┐
- │ Thanks!                    │
- └────────────────────────────┘
-
-Thanks for testing, bugfixes, discussions and everything I forgot go out to:
-
-  Adrien Schildknecht, aksr, bitonic, chrysn, Conley Moorhous, darkraven, Deiz,
-  Emil Mikulic, Feh, flo, Francesco Mazzoli, hax404, joepd, Kacper Kowalik,
-  Markus, meaneye, Merovius, Michael Walle, moju, Moritz, noxxun, Oliver
-  Kiddle, Pauli Ervi, Pavel Löbl, Piotr, pkordy, Quentin Glidic, Sascha Kruse,
-  Sebastian Ullrich, Simon Elsbrock, slowpoke, strcat, Tblue, Tim, whitequark,
-  xeen, Yaroslav Molochko
-
--- Michael Stapelberg, 2012-12-12

RELEASE-NOTES-4.5

@@ -1,103 +0,0 @@
-
- ┌──────────────────────────────┐
- │ Release notes for i3 v4.5    │
- └──────────────────────────────┘
-
-This is the i3 v4.5. This version is considered stable. All users of i3 are
-strongly encouraged to upgrade.
-
-Most of the changes are cleanups and bugfixes. Due to cleanups, i3 no longer
-  depends on flex/bison at all. Furthermore, libev ≥ 4 is now a hard dependency
-  (libev < 4 is not supported anymore).
-
-One important change to note is that moving windows to a different output will
-  no longer move focus to that output. If you want to have the old behavior,
-  modify the keybindings for moving in your configfile like this:
-
-    bindsym $mod+Shift+1 move workspace 1; workspace 1
-
- ┌────────────────────────────┐
- │ Changes in v4.5            │
- └────────────────────────────┘
-
-  • docs/hacking-howto: refer people to cr.i3wm.org
-  • docs/ipc: Adds Go IPC lib to the docs.
-  • docs/userguide: remove obsolete sentence about client.background
-  • docs/userguide: be explicit about assignment processing order
-  • docs/userguide: be more clear about the resize command arguments
-  • docs/userguide: fix typo: s/11x/11px/
-  • i3-dmenu-desktop: don’t add “geany” if “Geany” is already present
-  • i3-dmenu-desktop: strip newlines from dmenu ≥ 4.4
-  • i3-dmenu-desktop: skip files with broken utf8 but warn about it
-  • i3-dmenu-desktop: skip broken files (no/empty Exec=) but warn about them
-  • i3-dmenu-desktop: List filenames of .desktop files
-  • i3-dmenu-desktop: remove %i from commandline
-  • i3-nagbar: Work around terminals not supporting -e with quoted arguments
-  • i3-nagbar: use the same font as configured for i3
-  • i3bar: set _NET_SYSTEM_TRAY_COLORS for symbolic icons (gtk3+)
-  • i3bar: don’t use X11 borders to avoid overlapping in hide mode
-  • i3bar: separator color via config; separator width and on/off via ipc
-  • i3bar: Allow min_width of a block in i3bar to be a string
-  • i3-msg: parse command replies and display errors nicely if there were
-    errors
-  • Draw 1px tab separators left/right instead of 2px on the right only
-  • Render tree before destroying X11 containers upon unmap
-  • scratchpad show: move visible scratchpad window from another workspace to
-    focused workspace instead of doing nothing
-  • ignore MotionNotify events generated while warping the pointer
-  • Allow X11 servers which do not support the XKB extension.
-  • remove the urgency indicator when a window is closed
-  • wrap when moving containers to outputs with direction
-  • scratchpad_show: focus unfocused scratchpad window
-  • Split workspace instead of changing orientation
-  • scratchpad: always auto center on 'scratchpad show' if window hasn't been
-    repositioned by the user
-  • Add a new IPC event for changes on windows.
-  • config: accept “smart” as popup_during_fullscreen parameter
-  • Add support for _NET_WM_STATE_DEMANDS_ATTENTION.
-  • Obey WM_SIZE_HINTS's resize increments in floating mode
-  • Do not move focus if a container is moved across outputs
-
- ┌────────────────────────────┐
- │ Bugfixes                   │
- └────────────────────────────┘
-
-  • Ignore ConfigureRequests for scratchpad windows
-  • Correctly parse `move ... workspace *_on_output`
-  • i3bar: Set separator color properly when drawing
-  • Properly parse commands like “move workspace torrent”
-  • Handle nested transient popups properly
-  • Fix decoration rect size for windows without border
-  • parse outputs as "word", not "string", to ignore trailing whitespace
-  • fix crash when disabling output without any windows
-  • scratchpad: fix crash when moving last window of an invisible workspace
-  • fix coordinates of scratchpad windows on output changes
-  • call scratchpad_show() when focusing scratchpad windows via criteria
-  • fix continuous resize bug in floating mode, e.g. with xbmc
-  • fix “overlapping” --release key bindings
-  • fix IPC messages writes with low buffer sizes
-  • unregister as window manager before restarting (fixes a race condition)
-  • Fix bind[code|sym] --release
-  • remove superfluous #include <xcb/xcb_atom.h>
-  • Makefile: Repect AR environment variable
-  • i3-input: restore input focus on exit()
-  • Also draw right tab border for split containers
-  • Fix scrolling on a tabbed titlebar which contains split cons
-  • Correctly close floating windows
-  • handle MapRequests sent between i3 registering as a wm and handling events
-  • i3bar: fake DestroyNotify and send MANAGER ClientMessages to fix tray restarts
-
- ┌────────────────────────────┐
- │ Thanks!                    │
- └────────────────────────────┘
-
-Thanks for testing, bugfixes, discussions and everything I forgot go out to:
-
-  Adrien Schildknecht, alex, András Mohari, Artem Shinkarov, badboy, bafain,
-  cradle, dcoppa, Donald, dRbiG, eeemsi, else, emias, f8l, Francesco Mazzoli,
-  jasper, joepd, Kacper Kowalik, Kai, knopwob, Marcos, Marius Muja, Mats,
-  MeanEYE, Merovius, oblique, paolo, phlux, Piotr S. Staszewski, pnutzh4x0r,
-  rasi, saurabhgeek92, Sebastian Rachuj, Sebastian Ullrich, slowpoke, Steven
-  Allen, supplantr, Tai-Lin Chu, Tucos, Vivien Didelot, xeen
-
--- Michael Stapelberg, 2013-03-12

RELEASE-NOTES-4.5.1

@@ -1,24 +0,0 @@
-
- ┌──────────────────────────────┐
- │ Release notes for i3 v4.5.1  │
- └──────────────────────────────┘
-
-This is the i3 v4.5.1, a bugfix release. This version is considered stable. All
-users of i3 are strongly encouraged to upgrade.
-
-This release fixes an i3 lockup when dragging floating windows from one monitor
-  to another.
-
-Furthermore, in the release process for v4.5, there was a human error leading
-  to i3 thinking that v4.5 is a debug version, therefore allocating 25 MB of
-  shared memory logging ringbuffer by default.
-
- ┌────────────────────────────┐
- │ Changes in v4.5.1          │
- └────────────────────────────┘
-
-  • Bugfix: Don’t warp the pointer when dragging floating windows
-  • i3-dmenu-desktop: improve error message when dmenu cannot be found
-  • Add YAJL_CFLAGS to i3-msg.mk
-
--- Michael Stapelberg, 2013-03-18

RELEASE-NOTES-4.6

@@ -1,99 +0,0 @@
-
- ┌──────────────────────────────┐
- │ Release notes for i3 v4.6    │
- └──────────────────────────────┘
-
-This is the i3 v4.6. This version is considered stable. All users of i3 are
-strongly encouraged to upgrade.
-
-The main improvement of this release is increased compatibility. We made a few
-tiny code changes and hope that Mathematica and Java applications will work
-better with i3 now. i3-nagbar should work with more terminal emulators than
-before.
-
-For debugging, the shmlog and debuglog commands can be sent via IPC to enable
-shared memory logging while i3 is running. For the large number of users using
-a release version (i.e. a version without shared memory logging by default),
-this will make debugging their issues much simpler.
-
-i3bar now supports click events and can be hidden/shown via an i3 IPC command.
-
- ┌────────────────────────────┐
- │ Changes in v4.6            │
- └────────────────────────────┘
-
-  • docs/userguide: mention forgotten layout splitv/splith
-  • docs/multi-monitor: nVidia ≥ 302.17 works just fine
-  • docs/wsbar: update (we have i3bar now, i3-wsbar is just an example)
-  • docs/testsuite: Document fixes and workarounds for test failures
-  • man/i3-msg.man: updated man page to include all options
-  • lib/i3test: clarify how to identify open_window() windows in i3 commands
-  • Use a saner sanity check for floating_reposition
-  • tabbed: floor(), put extra pixels into the last tab
-  • raise fullscreen windows on top of all other X11 windows
-  • Draw indicator border only for split layouts
-  • re-shuffle struct members to save a bit of memory
-  • Add 'NoDisplay=true' to i3.application.desktop
-  • Store aspect_ratio instead of weird proportional_{width,height}
-  • Implement shmlog command
-  • Implement debuglog command
-  • Implement unmark command
-  • actively delete _NET_WORKAREA on startup
-  • Handle the _NET_REQUEST_FRAME_EXTENTS ClientMessage (java compat)
-  • i3bar: add click events
-  • i3bar: fix -b parameter, fix usage description
-  • i3bar: restore compatibility with libyajl version 1
-  • i3bar: unhide hidden i3bar when mode is active
-  • i3bar: fix font display height in i3bar
-  • i3bar: introduced i3 command for changing the hidden state and mode
-  • i3bar: fix wrong placement of i3bar when connecting/disconnecting outputs
-  • i3bar: draw workspace buttons at x=0 instead of x=1
-  • i3-nagbar: take our terminal execution kludge to the next level
-  • i3-nagbar: Bugfix: -m requires an argument (crashes if none specified)
-  • i3-dmenu-desktop: run commands when they don’t match a .desktop file
-    (e.g. enter “i3 layout stacking”)
-  • i3-dmenu-desktop: honor Path= key
-  • contrib/dump-asy.pl: Fix $ and & in window titles
-  • contrib/dump-asy.pl: Display nicer double-quotes
-  • contrib/gtk-tree-watch.pl: Remove bogus default socket path
-
- ┌────────────────────────────┐
- │ Bugfixes                   │
- └────────────────────────────┘
-
-  • Bugfix: ipc: use correct workspace in workspace change event
-  • Bugfix: fix floating window size with hide_edge_borders
-  • Bugfix: Fix parsing of comments in the config file
-  • Bugfix: Fix error messages for the debug log
-  • Bugfix: shm_unlink the correct file when handling errors
-  • Bugfix: Fix shm logging on FreeBSD
-  • Bugfix: Fix restarting with 32 bit depth windows
-  • Bugfix: Fix scratchpad_show on non-scratchpad windows
-  • Bugfix: i3bar: mark IPC fd CLOEXEC
-  • Bugfix: fix crash when not having tray_output configured
-  • Bugfix: make sure that resize will take place even if pixel is smaller
-    than size increments.
-  • Bugfix: render_con: fix height rounding in aspect ratio computation
-  • Bugfix: fix problem when moving fullscreen window to scratchpad
-  • Bugfix: Unmap windows before reparenting them to the root window
-    (fixes Mathematica)
-  • Bugfix: update parent urgency hint if a child is removed.
-  • Bugfix: fix bus error on OpenBSD/sparc64
-  • Bugfix: fix focus handling in 'floating disable' on non-visible windows
-  • Bugfix: ignore spaces in front of default workspace name
-  • Bugfix: call i3-nagbar correctly for configfiles without the font directive
-  • Bugfix: resize and center a scratchpad even when a criteria is used.
-
- ┌────────────────────────────┐
- │ Thanks!                    │
- └────────────────────────────┘
-
-Thanks for testing, bugfixes, discussions and everything I forgot go out to:
-
-  Alexander, Alexander Berntsen, Arun Persaud, badboy, Baptiste Daroussin,
-  Clément Bœsch, Diego Ongaro, Eelis van der Weegen, Eika Enge, enkore, Eric S.
-  Raymond, Franck Michea, haptix, HedgeMage, koebi, Layus, Mayhem, Merovius,
-  necoro, oblique, Philippe Virouleau, phillip, psychon, Simon Elsbrock, Simon
-  Wesp, Thomas Adam, tobiasu, vandannen, xeen, Yuxuan Shui
-
--- Michael Stapelberg, 2013-08-07

common.mk

@@ -1,204 +0,0 @@
-UNAME=$(shell uname)
-DEBUG=1
-COVERAGE=0
-INSTALL=install
-FLEX=flex
-BISON=bison
-ifndef PREFIX
-  PREFIX=/usr
-endif
-ifndef SYSCONFDIR
-  ifeq ($(PREFIX),/usr)
-    SYSCONFDIR=/etc
-  else
-    SYSCONFDIR=$(PREFIX)/etc
-  endif
-endif
-
-# In dist tarballs, the version is stored in the I3_VERSION and VERSION files.
-I3_VERSION := '$(shell [ -f $(TOPDIR)/I3_VERSION ] && cat $(TOPDIR)/I3_VERSION)'
-VERSION := '$(shell [ -f $(TOPDIR)/VERSION ] && cat $(TOPDIR)/VERSION)'
-ifeq ('',$(I3_VERSION))
-VERSION := $(shell git describe --tags --abbrev=0)
-I3_VERSION := '$(shell git describe --tags --always) ($(shell git log --pretty=format:%cd --date=short -n1), branch \"$(shell git describe --tags --always --all | sed s:heads/::)\")'
-endif
-
-MAJOR_VERSION := $(shell echo ${VERSION} | cut -d '.' -f 1)
-MINOR_VERSION := $(shell echo ${VERSION} | cut -d '.' -f 2)
-PATCH_VERSION := $(shell echo ${VERSION} | cut -d '.' -f 3)
-ifeq (${PATCH_VERSION},)
-PATCH_VERSION := 0
-endif
-
-## Generic flags
-
-# Default CFLAGS that users should be able to override
-ifeq ($(DEBUG),1)
-# Extended debugging flags, macros shall be available in gcc
-CFLAGS ?= -pipe -gdwarf-2 -g3
-else
-CFLAGS ?= -pipe -O2 -freorder-blocks-and-partition
-endif
-
-# Default LDFLAGS that users should be able to override
-LDFLAGS ?= $(as_needed_LDFLAG)
-
-# Common CFLAGS for all i3 related binaries
-I3_CFLAGS  = -std=c99
-I3_CFLAGS += -Wall
-# unused-function, unused-label, unused-variable are turned on by -Wall
-# We don’t want unused-parameter because of the use of many callbacks
-I3_CFLAGS += -Wunused-value
-I3_CFLAGS += -Iinclude
-
-I3_CPPFLAGS  = -DI3_VERSION=\"${I3_VERSION}\"
-I3_CPPFLAGS += -DMAJOR_VERSION=${MAJOR_VERSION}
-I3_CPPFLAGS += -DMINOR_VERSION=${MINOR_VERSION}
-I3_CPPFLAGS += -DPATCH_VERSION=${PATCH_VERSION}
-I3_CPPFLAGS += -DSYSCONFDIR=\"${SYSCONFDIR}\"
-I3_CPPFLAGS += -DI3__FILE__=__FILE__
-
-
-## Libraries flags
-
-ifeq ($(shell which pkg-config 2>/dev/null 1>/dev/null || echo 1),1)
-$(error "pkg-config was not found")
-endif
-
-# An easier way to get CFLAGS and LDFLAGS falling back in case there's
-# no pkg-config support for certain libraries.
-#
-# NOTE that you must not use a blank after comma when calling this:
-#     $(call ldflags_for_lib name, fallback) # bad
-#     $(call ldflags_for_lib name,fallback) # good
-# Otherwise, the compiler will get -l foo instead of -lfoo
-#
-# We redirect stderr to /dev/null because pkg-config prints an error if support
-# for gnome-config was enabled but gnome-config is not actually installed.
-cflags_for_lib = $(shell pkg-config --silence-errors --cflags $(1) 2>/dev/null)
-ldflags_for_lib = $(shell pkg-config --exists 2>/dev/null $(1) && pkg-config --libs $(1) 2>/dev/null || echo -l$(2))
-
-# XCB common stuff
-XCB_CFLAGS  := $(call cflags_for_lib, xcb)
-XCB_CFLAGS  += $(call cflags_for_lib, xcb-event)
-XCB_LIBS    := $(call ldflags_for_lib, xcb,xcb)
-XCB_LIBS    += $(call ldflags_for_lib, xcb-event,xcb-event)
-ifeq ($(shell pkg-config --exists xcb-util 2>/dev/null || echo 1),1)
-XCB_CFLAGS  += $(call cflags_for_lib, xcb-atom)
-XCB_CFLAGS  += $(call cflags_for_lib, xcb-aux)
-XCB_LIBS    += $(call ldflags_for_lib, xcb-atom,xcb-atom)
-XCB_LIBS    += $(call ldflags_for_lib, xcb-aux,xcb-aux)
-XCB_CPPFLAGS+= -DXCB_COMPAT
-else
-XCB_CFLAGS  += $(call cflags_for_lib, xcb-util)
-XCB_LIBS    += $(call ldflags_for_lib, xcb-util)
-endif
-
-# XCB keyboard stuff
-XCB_KBD_CFLAGS := $(call cflags_for_lib, xcb-keysyms)
-XCB_KBD_LIBS   := $(call ldflags_for_lib, xcb-keysyms,xcb-keysyms)
-
-# XCB WM stuff
-XCB_WM_CFLAGS := $(call cflags_for_lib, xcb-icccm)
-XCB_WM_CFLAGS += $(call cflags_for_lib, xcb-xinerama)
-XCB_WM_CFLAGS += $(call cflags_for_lib, xcb-randr)
-XCB_WM_LIBS   := $(call ldflags_for_lib, xcb-icccm,xcb-icccm)
-XCB_WM_LIBS   += $(call ldflags_for_lib, xcb-xinerama,xcb-xinerama)
-XCB_WM_LIBS   += $(call ldflags_for_lib, xcb-randr,xcb-randr)
-
-# Xlib
-X11_CFLAGS := $(call cflags_for_lib, x11)
-X11_LIBS   := $(call ldflags_for_lib, x11,X11)
-
-# Xcursor
-XCURSOR_CFLAGS := $(call cflags_for_lib, xcursor)
-XCURSOR_LIBS   := $(call ldflags_for_lib, xcursor,Xcursor)
-
-# yajl
-YAJL_CFLAGS := $(call cflags_for_lib, yajl)
-# Fallback for libyajl 1 which did not include yajl_version.h. We need
-# YAJL_MAJOR from that file to decide which code path should be used.
-YAJL_CFLAGS += -idirafter $(TOPDIR)/yajl-fallback
-YAJL_LIBS   := $(call ldflags_for_lib, yajl,yajl)
-
-#libev
-LIBEV_CFLAGS := $(call cflags_for_lib, libev)
-LIBEV_LIBS   := $(call ldflags_for_lib, libev,ev)
-
-# libpcre
-PCRE_CFLAGS := $(call cflags_for_lib, libpcre)
-ifeq ($(shell pkg-config --atleast-version=8.10 libpcre 2>/dev/null && echo 1),1)
-I3_CPPFLAGS += -DPCRE_HAS_UCP=1
-endif
-PCRE_LIBS   := $(call ldflags_for_lib, libpcre,pcre)
-
-# startup-notification
-LIBSN_CFLAGS := $(call cflags_for_lib, libstartup-notification-1.0)
-LIBSN_LIBS   := $(call ldflags_for_lib, libstartup-notification-1.0,startup-notification-1)
-
-# Pango
-PANGO_CFLAGS := $(call cflags_for_lib, cairo)
-PANGO_CFLAGS += $(call cflags_for_lib, pangocairo)
-I3_CPPFLAGS  += -DPANGO_SUPPORT=1
-PANGO_LIBS   := $(call ldflags_for_lib, cairo)
-PANGO_LIBS   += $(call ldflags_for_lib, pangocairo)
-
-# libi3
-LIBS = -L$(TOPDIR) -li3
-
-## Platform-specific flags
-
-# Please test if -Wl,--as-needed works on your platform and send me a patch.
-# it is known not to work on Darwin (Mac OS X)
-ifneq (,$(filter Linux GNU GNU/%, $(UNAME)))
-as_needed_LDFLAG = -Wl,--as-needed
-endif
-
-ifeq ($(UNAME),NetBSD)
-# We need -idirafter instead of -I to prefer the system’s iconv over GNU libiconv
-I3_CFLAGS += -idirafter /usr/pkg/include
-I3_LDFLAGS += -Wl,-rpath,/usr/local/lib -Wl,-rpath,/usr/pkg/lib
-endif
-
-ifeq ($(UNAME),OpenBSD)
-I3_CFLAGS += -I${X11BASE}/include
-LIBS += -liconv
-I3_LDFLAGS += -L${X11BASE}/lib
-endif
-
-ifeq ($(UNAME),FreeBSD)
-LIBS += -liconv
-endif
-
-ifeq ($(UNAME),Darwin)
-LIBS += -liconv
-else
-# Darwin (Mac OS X) doesn’t have librt
-LIBS += -lrt
-endif
-
-ifneq (,$(filter Linux GNU GNU/%, $(UNAME)))
-I3_CPPFLAGS += -D_GNU_SOURCE
-endif
-
-
-ifeq ($(COVERAGE),1)
-I3_CFLAGS += -fprofile-arcs -ftest-coverage
-LIBS += -lgcov
-endif
-
-V ?= 0
-ifeq ($(V),0)
-# Don’t print command lines which are run
-.SILENT:
-
-# echo-ing vars
-V_ASCIIDOC = echo ASCIIDOC $@;
-V_POD2HTML = echo POD2HTML $@;
-V_POD2MAN = echo POD2MAN $@;
-V_A2X = echo A2X $@;
-endif
-
-# Always remake the following targets
-.PHONY: install clean dist distclean
-

contrib/banner.svg

@@ -319,7 +319,7 @@
             <dc:title>steckdenis</dc:title>
           </cc:Agent>
         </dc:creator>
-        <dc:description>Logo for I3, an improved dynamic tiling window manager: http://i3.zekjur.net/</dc:description>
+        <dc:description>Logo for i3 - an improved tiling window manager: http://i3.zekjur.net/</dc:description>
         <cc:license
            rdf:resource="http://creativecommons.org/licenses/by-sa/3.0/" />
       </cc:Work>

contrib/dump-asy.pl

@@ -1,19 +1,35 @@
 #!/usr/bin/env perl
 # vim:ts=4:sw=4:expandtab
-# renders the layout tree using asymptote
-#
-# ./dump-asy.pl
-#   will render the entire tree
-# ./dump-asy.pl 'name'
-#   will render the tree starting from the node with the specified name,
-#   e.g. ./dump-asy.pl 2 will render workspace 2 and below
 
 use strict;
 use warnings;
 use Data::Dumper;
+use Getopt::Long;
+use Pod::Usage;
 use AnyEvent::I3;
 use File::Temp;
+use File::Spec;
+use File::Basename;
 use v5.10;
+use IPC::Cmd qw[can_run];
+
+my %options = (
+    gv => 1,
+    save => undef,
+    help => 0,
+);
+my $result = GetOptions(
+    "gv!" => \$options{gv},
+    "save=s" => \$options{save},
+    "help|?" => \$options{help},
+);
+
+pod2usage(-verbose => 2, -exitcode => 0) if $options{help};
+
+# prerequisites check so we can be specific about failures caused
+# by not having these tools in the path
+can_run('asy') or die 'Please install asymptote';
+can_run('gv') or die 'Please install gv' unless !$options{gv};
 
 my $i3 = i3();
 
@@ -30,7 +46,7 @@ sub dump_node {
 
     my $o = ($n->{orientation} eq 'none' ? "u" : ($n->{orientation} eq 'horizontal' ? "h" : "v"));
     my $w = (defined($n->{window}) ? $n->{window} : "N");
-    my $na = $n->{name};
+    my $na = ($n->{name} or ($n->{type} eq "floating_con" ? "[Floating con]" : "[Empty]"));
     $na =~ s/#/\\#/g;
     $na =~ s/\$/\\\$/g;
     $na =~ s/&/\\&/g;
@@ -38,16 +54,18 @@ sub dump_node {
     $na =~ s/~/\\textasciitilde{}/g;
     my $type = 'leaf';
     if (!defined($n->{window})) {
-        $type = $n->{orientation} . '-split';
+        $type = $n->{layout};
     }
-    my $name = qq|``$na'' ($type)|;
+    my $marks = $n->{marks} ? ' [' . join('][', @{$n->{marks}}) . ']' : '';
+    my $name = qq|``$na'' ($type)$marks|;
 
     print $tmp "TreeNode n" . $n->{id} . " = makeNode(";
 
     print $tmp "n" . $parent->{id} . ", " if defined($parent);
     print $tmp "\"" . $name . "\");\n";
 
-	dump_node($_, $n) for @{$n->{nodes}};
+    dump_node($_, $n) for @{$n->{nodes}};
+    dump_node($_, $n) for @{$n->{floating_nodes}};
 }
 
 sub find_node_with_name {
@@ -75,4 +93,60 @@ say $tmp "draw(n" . $root->{id} . ", (0, 0));";
 close($tmp);
 my $rep = "$tmp";
 $rep =~ s/asy$/eps/;
-system("cd /tmp && asy $tmp && gv --scale=-1000 --noresize --widgetless $rep && rm $rep");
+if ($options{gv}) {
+    my $tmp_dir = dirname($rep);
+    $options{save} = File::Spec->rel2abs($options{save}) if $options{save};
+    chdir($tmp_dir);
+} else {
+    $rep = basename($rep);  # Output in current dir.
+}
+system("asy $tmp");  # Create the .eps file.
+system("gv --scale=-1000 --noresize --widgetless $rep") if $options{gv};
+if ($options{save}) {
+    system("mv $rep ${options{save}}");
+} elsif ($options{gv}) {
+    system("rm $rep");
+}
+system("rm $tmp");
+
+__END__
+
+=head1 NAME
+
+dump-asy.pl - Render the layout tree using asymptote
+
+=head1 SYNOPSIS
+
+dump-asy.pl [workspace]
+
+=head1 EXAMPLE
+
+Render the entire tree, run:
+
+  ./dump-asy.pl
+
+Render the tree starting from the node with the specified name, run:
+
+  ./dump-asy.pl 'name'
+
+Render the entire tree, save in file 'file.eps' and show using gv, run:
+
+  ./dump-asy.pl --save file.eps
+
+=head1 OPTIONS
+
+=over 8
+
+=item B<--gv>
+
+=item B<--no-gv>
+
+Enable or disable showing the result through gv. If disabled, an .eps file will
+be saved in the current working directory. Enabled by default.
+
+=item B<--save>
+
+Save result using the specified file-name. If omitted, no file will be saved
+when using '--gv' or a random name will be used when using '--no-gv'.
+
+=back

contrib/per-workspace-layout.pl

@@ -0,0 +1,56 @@
+#!/usr/bin/env perl
+# vim:ts=4:sw=4:expandtab
+# © 2012 Michael Stapelberg
+# Licensed under BSD license, see https://github.com/i3/i3/blob/next/LICENSE
+#
+# Append this line to your i3 config file:
+#     exec_always ~/per-workspace-layout.pl
+#
+# Then, change the %layouts hash like you want your workspaces to be set up.
+# This script requires i3 >= v4.4 for the extended workspace event.
+
+use strict;
+use warnings;
+use AnyEvent;
+use AnyEvent::I3;
+use v5.10;
+use utf8;
+
+my %layouts = (
+    '4' => 'tabbed',
+    '5' => 'stacked',
+);
+
+my $i3 = i3();
+
+die "Could not connect to i3: $!" unless $i3->connect->recv();
+
+die "Could not subscribe to the workspace event: $!" unless
+    $i3->subscribe({
+        workspace => sub {
+            my ($msg) = @_;
+            return unless $msg->{change} eq 'focus';
+            die "Your version of i3 is too old. You need >= v4.4"
+                unless exists($msg->{current});
+            my $ws = $msg->{current};
+
+            # If the workspace already has children, don’t change the layout.
+            return unless scalar @{$ws->{nodes}} == 0;
+
+            my $name = $ws->{name};
+            my $con_id = $ws->{id};
+
+            return unless exists $layouts{$name};
+
+            $i3->command(qq|[con_id="$con_id"] layout | . $layouts{$name});
+        },
+        _error => sub {
+            my ($msg) = @_;
+            say "AnyEvent::I3 error: $msg";
+            say "Exiting.";
+            exit 1;
+        },
+    })->recv->{success};
+
+# Run forever.
+AnyEvent->condvar->recv

contrib/sticker_stickma_black.svg

@@ -329,7 +329,7 @@
             <dc:title>steckdenis</dc:title>
           </cc:Agent>
         </dc:creator>
-        <dc:description>Logo for I3, an improved dynamic tiling window manager: http://i3.zekjur.net/</dc:description>
+        <dc:description>Logo for i3 - an improved tiling window manager: http://i3.zekjur.net/</dc:description>
         <cc:license
            rdf:resource="http://creativecommons.org/licenses/by-sa/3.0/" />
       </cc:Work>

debian/changelog

@@ -1,8 +1,255 @@
-i3-wm (4.5.2-1) experimental; urgency=low
+i3-wm (4.24-1) unstable; urgency=medium
 
-  * NOT YET RELEASED
+  * New upstream release.
 
- -- Michael Stapelberg <stapelberg@debian.org>  Mon, 18 Mar 2013 23:01:30 +0100
+ -- Michael Stapelberg <stapelberg@debian.org>  Wed, 06 Nov 2024 18:34:06 +0100
+
+i3-wm (4.23-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 29 Oct 2023 15:42:11 +0100
+
+i3-wm (4.22-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 02 Jan 2023 09:46:22 +0100
+
+i3-wm (4.21.2-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 24 Oct 2022 21:22:36 +0200
+
+i3-wm (4.21.1-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 24 Oct 2022 21:22:36 +0200
+
+i3-wm (4.21-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Wed, 21 Sep 2022 18:14:14 +0200
+
+i3-wm (4.20.1-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Wed, 03 Nov 2021 09:22:48 +0100
+
+i3-wm (4.20-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sat, 27 Feb 2021 10:32:17 +0100
+
+i3-wm (4.19.2-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sat, 27 Feb 2021 10:32:17 +0100
+
+i3-wm (4.19-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 19 Oct 2020 22:48:30 +0200
+
+i3-wm (4.18.3-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 19 Oct 2020 22:48:30 +0200
+
+i3-wm (4.18.2-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 26 Jul 2020 10:24:46 +0200
+
+i3-wm (4.18.1-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Wed, 22 Apr 2020 09:04:42 +0200
+
+i3-wm (4.18-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 17 Feb 2020 18:25:47 +0100
+
+i3-wm (4.17.1-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Fri, 30 Aug 2019 23:06:40 +0200
+
+i3-wm (4.17-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sat, 03 Aug 2019 15:14:28 +0200
+
+i3-wm (4.16.1-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 27 Jan 2019 16:45:11 +0100
+
+i3-wm (4.16-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 04 Nov 2018 14:47:25 +0100
+
+i3-wm (4.15-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sat, 10 Mar 2018 17:27:26 +0100
+
+i3-wm (4.14.1-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 24 Sep 2017 19:21:15 +0200
+
+i3-wm (4.14-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Mon, 04 Sep 2017 07:53:16 +0200
+
+i3-wm (4.13-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Tue, 08 Nov 2016 19:02:16 +0100
+
+i3-wm (4.12-2) unstable; urgency=medium
+
+  * Override lintian warning desktop-entry-contains-unknown-key for
+    DesktopNames, gdm needs that key.
+  * Remove i3-wm.menu to conform to the tech-ctte decision on #741573.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Fri, 01 Apr 2016 15:51:23 +0200
+
+i3-wm (4.12-1) unstable; urgency=medium
+
+  * New upstream release.
+  * Move to debhelper 9
+  * Bump Standards-Version to 3.9.7 (no changes necessary)
+  * debian/watch: verify signature, use https
+  * Enable full hardening
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 06 Mar 2016 14:20:38 +0100
+
+i3-wm (4.11-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Wed, 30 Sep 2015 08:50:13 +0200
+
+i3-wm (4.10.4-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Tue, 08 Sep 2015 09:15:45 +0200
+
+i3-wm (4.10.3-1) unstable; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Thu, 30 Jul 2015 21:51:27 +0200
+
+i3-wm (4.10.2-2) unstable; urgency=medium
+
+  * New upstream release.
+  * experimental to unstable because i3-wm 4.10.2-1 was only in experimental
+    due to the freeze.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Fri, 01 May 2015 20:21:18 +0200
+
+i3-wm (4.10.2-1) experimental; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Thu, 16 Apr 2015 09:02:53 +0200
+
+i3-wm (4.10.1-1) experimental; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 29 Mar 2015 18:54:07 +0200
+
+i3-wm (4.10-1) experimental; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 29 Mar 2015 17:46:09 +0200
+
+i3-wm (4.9.1-1) experimental; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sat, 07 Mar 2015 20:01:46 +0100
+
+i3-wm (4.9-1) experimental; urgency=medium
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sat, 28 Feb 2015 14:53:34 +0100
+
+i3-wm (4.8-2) unstable; urgency=medium
+
+  * Backport two bugfixes:
+    - backport-dpi-fix.patch (Closes: #778460)
+    - backport-i3bar-tray-fix.patch (Closes: #778461)
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 15 Feb 2015 13:24:42 +0100
+
+i3-wm (4.8-1) unstable; urgency=medium
+
+  * New upstream release.
+  * Bump standards-version to 3.9.5 (no changes necessary)
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 15 Jun 2014 19:15:29 +0200
+
+i3-wm (4.7.2-1) unstable; urgency=low
+
+  * New upstream release. (Closes: #736396)
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Thu, 23 Jan 2014 23:03:03 +0100
+
+i3-wm (4.7.1-1) unstable; urgency=low
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Tue, 21 Jan 2014 19:29:34 +0100
+
+i3-wm (4.7-1) unstable; urgency=low
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Sun, 22 Dec 2013 21:19:02 +0100
+
+i3-wm (4.6-1) unstable; urgency=low
+
+  * New upstream release.
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Wed, 07 Aug 2013 20:53:26 +0200
+
+i3-wm (4.5.1-2) unstable; urgency=low
+
+  * experimental to unstable because i3-wm 4.5.1 was only in experimental due
+    to the freeze.
+  * bump standards-version to 3.9.4 (no changes necessary)
+
+ -- Michael Stapelberg <stapelberg@debian.org>  Tue, 14 May 2013 20:48:16 +0200
 
 i3-wm (4.5.1-1) experimental; urgency=low
 
@@ -181,7 +428,7 @@ i3-wm (4.0.2-1) unstable; urgency=low
   * Bugfix: Use correct format string in load_layout (fixes crash in restart)
   * Bugfix: Fix border rendering (border lines were "cutting" through)
   * Bugfix: Raise floating windows immediately when dragging/resizing
-  * Bugfix: Make focus switching work accross outputs again
+  * Bugfix: Make focus switching work across outputs again
   * Bugfix: migration-script: handle resize top/bottom correctly
   * Bugfix: Fix focus issue when moving containers to workspaces
   * Bugfix: Warp cursor when changing outputs again
@@ -416,7 +663,7 @@ i3-wm (3.d-bf1-1) unstable; urgency=low
   * Bugfix: Resize client after updating base_width/base_height
   * Bugfix: Force render containers after setting the client active
   * Bugfix: Fix two problems in resizing floating windows with right mouse
-  * Bugfix: Use more precise floating point arithmetics
+  * Bugfix: Use more precise floating point arithmetic
   * Bugfix: Correctly place new windows below fullscreen windows
 
  -- Michael Stapelberg <michael@stapelberg.de>  Mon, 21 Dec 2009 22:33:02 +0100

debian/compat

@@ -1 +1 @@
-7
+10

debian/control

@@ -2,27 +2,33 @@ Source: i3-wm
 Section: x11
 Priority: extra
 Maintainer: Michael Stapelberg <stapelberg@debian.org>
-Build-Depends: debhelper (>= 7.0.50~),
+Build-Depends: debhelper (>= 10),
+               meson,
                libx11-dev,
                libxcb-util0-dev (>= 0.3.8),
                libxcb-keysyms1-dev,
                libxcb-xinerama0-dev (>= 1.1),
                libxcb-randr0-dev,
                libxcb-icccm4-dev,
-               libxcursor-dev,
+               libxcb-cursor-dev,
+               libxcb-xrm-dev,
+               libxcb-xkb-dev,
+               libxcb-shape0-dev,
+               libxkbcommon-dev (>= 0.4.0),
+               libxkbcommon-x11-dev (>= 0.4.0),
                asciidoc (>= 8.4.4),
                xmlto,
                docbook-xml,
                pkg-config,
                libev-dev (>= 1:4.04),
-               libyajl-dev,
-               libpcre3-dev,
+               libyajl-dev (>= 2.0.4),
+               libpcre2-dev,
                libstartup-notification0-dev (>= 0.10),
-               libcairo2-dev,
+               libcairo2-dev (>= 1.14.4),
                libpango1.0-dev,
                libpod-simple-perl
-Standards-Version: 3.9.3
-Homepage: http://i3wm.org/
+Standards-Version: 3.9.8
+Homepage: https://i3wm.org/
 
 Package: i3
 Architecture: any
@@ -35,11 +41,10 @@ Description: metapackage (i3 window manager, screen locker, menu, statusbar)
 
 Package: i3-wm
 Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}, ${perl:Depends}, x11-utils
+Depends: ${shlibs:Depends}, ${misc:Depends}, ${perl:Depends}
 Provides: x-window-manager
-Suggests: rxvt-unicode | x-terminal-emulator
-Recommends: xfonts-base
-Description: improved dynamic tiling window manager
+Recommends: xfonts-base, fonts-dejavu-core, libanyevent-i3-perl (>= 0.12), libjson-xs-perl, rxvt-unicode | x-terminal-emulator
+Description: improved tiling window manager
  Key features of i3 are good documentation, reasonable defaults (changeable in
  a simple configuration file) and good multi-monitor support. The user
  interface is designed for power users and emphasizes keyboard usage. i3 uses

debian/copyright

@@ -1,30 +1,41 @@
-This Debian package is based on a tarball downloaded from
-http://i3wm.org/
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: i3
+Upstream-Contact: Michael Stapelberg <michael@i3wm.org>
+Source: https://i3wm.org/
 
-Copyright: (C) 2009-2011 Michael Stapelberg <michael+i3 at stapelberg dot de>
-All rights reserved.
+Files: *
+Copyright: 2009 Michael Stapelberg
+License: BSD-3-clause
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Files: debian/*
+Copyright: 2009 Michael Stapelberg
+License: BSD-3-clause
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this
-  list of conditions and the following disclaimer in the documentation and/or other
-  materials provided with the distribution.
-
-* Neither the name of Michael Stapelberg, i3 nor the names of its contributors
-  may be used to endorse or promote products derived from this software without
-  specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
-EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
-SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
-BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
-ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGE.
+License: BSD-3-clause
+ Copyright: © 2009 Michael Stapelberg <michael at i3wm dot org>
+ All rights reserved.
+ .
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+ .
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+ .
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+ .
+ * Neither the name of Michael Stapelberg, i3 nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+ .
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

debian/i3-wm.docs

@@ -1,31 +0,0 @@
-docs/debugging.html
-docs/hacking-howto.html
-docs/i3bar-protocol.html
-docs/userguide.html
-docs/bigpicture.png
-docs/single_terminal.png
-docs/snapping.png
-docs/two_columns.png
-docs/two_terminals.png
-docs/modes.png
-docs/stacklimit.png
-docs/ipc.html
-docs/multi-monitor.html
-docs/wsbar.html
-docs/wsbar.png
-docs/keyboard-layer1.png
-docs/keyboard-layer2.png
-docs/testsuite.html
-docs/i3-sync-working.png
-docs/i3-sync.png
-docs/tree-layout1.png
-docs/tree-layout2.png
-docs/tree-shot1.png
-docs/tree-shot2.png
-docs/tree-shot3.png
-docs/tree-shot4.png
-docs/refcard.html
-docs/refcard_style.css
-docs/logo-30.png
-docs/lib-i3test.html
-docs/lib-i3test-test.html

debian/i3-wm.install

@@ -0,0 +1,7 @@
+debian/tmp/etc
+debian/tmp/usr
+contrib/dump-asy.pl usr/share/doc/i3-wm/examples/
+contrib/gtk-tree-watch.pl usr/share/doc/i3-wm/examples/
+contrib/i3-wsbar usr/share/doc/i3-wm/examples/
+contrib/per-workspace-layout.pl usr/share/doc/i3-wm/examples/
+contrib/trivial-bar-script.sh usr/share/doc/i3-wm/examples/

debian/i3-wm.links

@@ -0,0 +1 @@
+usr/share/man/man1/i3.1.gz usr/share/man/man1/i3-with-shmlog.1.gz

debian/i3-wm.manpages

@@ -1,12 +0,0 @@
-man/i3.1
-man/i3-msg.1
-man/i3-input.1
-man/i3-nagbar.1
-man/i3-config-wizard.1
-man/i3-dump-log.1
-man/i3-migrate-config-to-v4.1
-man/i3-sensible-pager.1
-man/i3-sensible-editor.1
-man/i3-sensible-terminal.1
-man/i3-dmenu-desktop.1
-man/i3bar.1

debian/i3-wm.menu

@@ -1,5 +0,0 @@
-?package(i3-wm): \
-	needs="wm" \
-	section="Window Managers" \
-	title="i3" \
-	command="/usr/bin/i3"

debian/patches/manpage-x-terminal-emulator.patch

@@ -1,20 +0,0 @@
-Description: list x-terminal-emulator as one of i3-sensible-terminal’s choices
-Author: Michael Stapelberg <stapelberg@debian.org>
-Origin: vendor
-Forwarded: not-needed
-Last-Update: 2011-12-28
-
----
-
-Index: i3-4.1.1/man/i3-sensible-terminal.man
-===================================================================
---- i3-4.1.1.orig/man/i3-sensible-terminal.man	2011-12-28 23:56:55.487581000 +0100
-+++ i3-4.1.1/man/i3-sensible-terminal.man	2011-12-28 23:57:06.725802633 +0100
-@@ -22,6 +22,7 @@
- It tries to start one of the following (in that order):
- 
- * $TERMINAL (this is a non-standard variable)
-+* x-terminal-emulator
- * urxvt
- * rxvt
- * terminator

debian/patches/series

@@ -1,2 +0,0 @@
-use-x-terminal-emulator.patch
-manpage-x-terminal-emulator.patch

debian/patches/use-x-terminal-emulator.patch

@@ -1,25 +0,0 @@
-Description: i3-sensible-terminal: try x-terminal-emulator first
-Author: Michael Stapelberg <stapelberg@debian.org>
-Origin: vendor
-Forwarded: not-needed
-Last-Update: 2012-09-19
-
----
-
-Index: i3-4.3/i3-sensible-terminal
-===================================================================
---- i3-4.3.orig/i3-sensible-terminal	2012-09-19 18:08:09.000000000 +0200
-+++ i3-4.3/i3-sensible-terminal	2012-09-19 18:32:06.393883488 +0200
-@@ -4,11 +4,7 @@
- #
- # This script tries to exec a terminal emulator by trying some known terminal
- # emulators.
--#
--# Distributions/packagers should enhance this script with a
--# distribution-specific mechanism to find the preferred terminal emulator. On
--# Debian, there is the x-terminal-emulator symlink for example.
--for terminal in $TERMINAL urxvt rxvt terminator Eterm aterm xterm gnome-terminal roxterm xfce4-terminal; do
-+for terminal in $TERMINAL x-terminal-emulator urxvt rxvt terminator Eterm aterm xterm gnome-terminal roxterm xfce4-terminal; do
-     if which $terminal > /dev/null 2>&1; then
-         exec $terminal "$@"
-     fi

debian/rules

@@ -1,47 +1,21 @@
 #!/usr/bin/make -f
 # vi: ts=8 sw=8 noet
 
-DPKG_EXPORT_BUILDFLAGS = 1
--include /usr/share/dpkg/buildflags.mk
-
-ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
-    NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
-    MAKEFLAGS += -j$(NUMJOBS)
-endif
-
-build: build-arch build-indep
-build-arch: build-stamp
-build-indep: build-stamp
-build-stamp:
-	dh build
-	touch build-stamp
-
-clean:
-	dh clean
-
-install: build install-stamp
-install-stamp:
-	dh install
-	touch install-stamp
-
-binary-arch: install
-	dh binary-arch
-
-binary-indep: install
-	dh binary-indep
-
-binary: binary-arch binary-indep
-
-override_dh_auto_build:
-	$(MAKE)
-	$(MAKE) -C man
-	$(MAKE) -C docs
+export V:=1
+export DEB_BUILD_MAINT_OPTIONS = hardening=+all
 
 override_dh_installchangelogs:
-	dh_installchangelogs RELEASE-NOTES-4.5.1
-
-override_dh_install:
-	$(MAKE) DESTDIR=$(CURDIR)/debian/i3-wm/ install
+	dh_installchangelogs RELEASE-NOTES-*
 
 override_dh_strip:
 	dh_strip --dbg-package=i3-wm-dbg
+
+override_dh_auto_test:
+	# TODO: enable tests
+
+override_dh_auto_configure:
+	# Set -Ddocdir; the default is /usr/share/doc/i3
+	dh_auto_configure -- -Ddocdir=/usr/share/doc/i3-wm -Dmans=true
+
+%:
+	dh $@ --buildsystem=meson

debian/upstream/signing-key.asc

@@ -0,0 +1,56 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1
+
+mQINBEoVG4cBEADX2160pBoUf2vSWKbUa8soEMscBFjmb/NajCxwX/BlD1sVNyDm
+twZ74CNPS7X5GgNQoXCzkm7v18zOpON69/pwQ0C4T4P+dvewaDzi2+4/bZsXSor1
+mA3C9lHcKDbpH7jHkN2AbMnY3Z4LD46LA1qfCISAAKtx1h4peBF6Xhu743dKXrBa
+zg/TEJwWIWSyPKgIhur95yebD/Tws+gWlOfBKkF1v1PA+5sPmC8LyK5Rd1n9Sg1D
+j//4sWl8A4EwM4QUzSliZME775klV4mOBGbsTnhNjCymgDiXVNjoWdEIHoNfDsut
+E2czgSwsSrSPls/Kl1KuHyBiOWi4dl6MFaypcuSNEVNi5K+oJ7gmX/sy/TlF5Ofw
+KoBEPrcvulVT8aAM3azMfb/Fgo+GcEEYljV1yvSg7jSjCHxXgMyh/yMfZcPkwajp
+fNE5D7WAXgygpolM9dLIOBemDJxwWr0G7uhXNv3vSHpuUheb2REaJJwWHw1IuCmn
+gigD5mebQWRSmbEl66ygOFkps9FEq6KSmbHkj7dIrSVmK5DtQRRI5fMPI+E+atul
+Lnpgm/R2p2yvPKoS/pr9mwvKIf9F5C20wm1iAaGW1pTDSIl2y2ZpzcJIyS+jhyCX
+3d6D7FNEFlI2p9Tnbt9aE04ASLlZFGjxNWweU8zAkNOr1MyPTiWrYtsCtwARAQAB
+tCpNaWNoYWVsIFN0YXBlbGJlcmcgPG1pY2hhZWxAc3RhcGVsYmVyZy5kZT6JAkAE
+EwEKACoCGy8CHgECF4AFCwkIBwMFFQoJCAsFFgIDAQACGQEFAlNdKVoFCRKuD04A
+CgkQTnFg7UrI7h1HYw//R7WBr/MrqevbaB6Uh7Koy3rN1GqXXY7L4kQAO1XSrmC9
+IQ/giwg7+655tDWq4cAjefiBWRv0I1WWqZwdgUGwfhzW20DBx2sPkGKZ29pcvU/k
+LuMyWs49o2lcsb4cQqgDpH/uzi22fc4BhO91o/uZYOAXrrSlLuzkCa1SDCRymwdw
+lIXIXktROd+r6Fpc1FAinOQgn5BQjf7gbSZSlqBLeYZdR+qSxZWufrhsVUy03nVx
+mF9hc/aTFNYZHHHh0yFzYfBKisqsuwJW94uW80xw17HoBMSb10eNGEq5xWqh4Owu
+8heJePlcoh2F5JnO6cFWoz1bHCZGjeeIm0OdPJXTLDQdcA5Hy4K3ADidqW0y+Iza
+Wbs3TpLprLw91LaPcwzZf+vzRgsQCwPKODjhcetEaYGIKweCkNQRQCW6wEl7kRAw
+/eG1wdn4YfEcnCz4ye1MW67au3omvBy41BNmGb20rEc9JIQ37HhAJy5MwuguuO1Z
+xZWyu3fV39YLwvsa8EYFPb/DOUTmSCBCyvfTOCEC94Vl2kcPXicIpaRnCFZNqVEJ
+FAMKY/tSVjPsBEXTFx3aiX3am4CCtc8R95z2DrYtW5UU/yA5o6lDnfRX6Smdl620
+kTM/gFEgAI8+x56XsWJ/CnG//EbgKMy8u2u5y7x1SdpZFxLf722EryF0yPJt+im0
+OU1pY2hhZWwgU3RhcGVsYmVyZyAoUkVOVC1BLUdVUlUpIDxtaWNoYWVsQHJlbnQt
+YS1ndXJ1LmRlPokCPQQTAQoAJwIbLwIeAQIXgAULCQgHAwUVCgkICwUWAgMBAAUC
+U10pWgUJEq4PTgAKCRBOcWDtSsjuHUTREACcBXnZwinxZ8S0DOl2OR7qm8ao4U/n
+h71tkJX9klnXYY8KQD54tuGjYjCA+UvTOX7c0Rzj3WijgyRxefmOhPQzkk/zUheH
+bsaYSbj2mCvA/IkMRe6G0+wyFU5ydssLVApx/+bwdL3CiIoFPwyHMgWPjYuijIts
+UMbq7jtnF26l7O0GSY5uHSUQb7caz+Mu0CcF95h3oxRxHVAhHIMtwzkilbjbshEf
+nxDH5L0s2hT0amkEB2jw3US2v+YrThk0ZQPoB+tgNLL2Li7yAuwbaEaK37aDTtkX
+NdFiAwcOHrLhlD0SnNya4nEVwgnCu5B9f+OwalPq3a0+G394L+a+XHWWwXc6MlFz
+WhzAMeE1uFJfbIIGEL/Q3URBbhIUf0xsZEagsjNExgYtJY5XJRitgyxPwAuxusia
+VhfTmbr3Mr5yu7QEt1oACq3j0bNr7hzcPk+ckHYbsSvuoo21Ef5vhQetXpAzrot/
++62c7i1xcAvY7MVBT2f/7BC4cYvLXALhcvLAabzOcD8lBPEIBkxgJj42EckEzFzC
+c9s5htWdhWYIAIIdIOxZejxfRiTvujg5CaJo+Fg/BL4TTlBgjU7ASzMQBfos3cII
+F8O9Yc+W04uMyG9QPqk//rIUFdKgUyd4tzXkQrJs7Jom7duxJPpr5dDMLqTwINL5
+LBBKw/lpA/nAkLQqTWljaGFlbCBTdGFwZWxiZXJnIDxzdGFwZWxiZXJnQGRlYmlh
+bi5vcmc+iQI9BBMBCgAnAhsvBQsJCAcDBRUKCQgLBRYCAwEAAh4BAheABQJTXSla
+BQkSrg9OAAoJEE5xYO1KyO4dGBkP/353sh8feSyxJNXMdgAfe+okYE4B9iWS2zRy
+GAEGKyliaMWDJLRhT4ln1glr05pFoy52Hxe4+NBpSYuZ9NV390HRmPxbFaUvHs74
+HPkuABxy2XKH94IS1nrb+fleR00w0rLEin4aW3mtwKDHCJtNUW0/DNtC7Uz028SL
+9TftaqJrsf+paTFJkZF0ShJ2A6XFxwlvBiVz4f2UDEi7GQuAaYI5V5ZosWIAxdYG
+631tKf1EU9YtjPYdBk3YF4Q44AhVbe478Ji24Of0G/l+dGFRzbdARNayBwegJoMu
+djXQrPfR1jNVSaw65/AinbbtadlULSTrvhoD6ommGeU6fQS3WtNBbF4T5SuNRBeK
+QhWuLSOllmjWfERaj6omg8GXd1rctIFnUhT/dl6bmhooMPRUW1DNxVzqd7UFnqXE
++CaJ7cGfI/9/MITTG32QpjkVeowOcuoZ+qLoOu7dBbagDaEn8T6yFCLACyf9LGBm
+MC9bNSGsMRCFV33N/PbVcgf6M0z46d0ysPgGiR5MX1O6CQkJGrwolfA5sK3VIsyp
+PaCCHpAuPdEiWB57WleURqCIGWV2ccElyA4M4auDGt1SSNl0NfWu8vde6wNIPir/
+DBqh1265QLrLS239UT0u5hYE5hkfiKP2dzgWKh9NT9xm2Dyjjv/PaqWlVedvsVIp
+VRx/oRxr
+=1n/p
+-----END PGP PUBLIC KEY BLOCK-----

debian/watch

@@ -1,2 +1,3 @@
 version=3
-http://i3wm.org/downloads/ /downloads/i3-(.*)\.tar\.bz2
+opts=pgpsigurlmangle=s/$/.asc/ \
+  https://i3wm.org/downloads/ /downloads/i3-(.*)\.tar\.bz2

docs/Makefile

@@ -1,7 +0,0 @@
-all:
-	$(MAKE) -C .. docs
-
-clean:
-	$(MAKE) -C .. clean-docs
-
-.PHONY: all clean

docs/NoName-2009-03-12/i3.tex

@@ -29,7 +29,7 @@
 		add_ignore_event, xcb_intern_atom, xcb_intern_atom_reply, fprintf, printf, free, load_configuration,%
 		XInternAtom, exit, strlen}}
 }{}
-\title{i3 - an improved dynamic tiling window manager}
+\title{i3 - an improved tiling window manager}
 \author{sECuRE beim NoName e.V.\\
 ~\\
 powered by \LaTeX, of course}

docs/asciidoc-git.conf

@@ -520,8 +520,8 @@ cellspacing="0" cellpadding="4">
 
 [header]
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang=en}">
+    "https://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="{lang=en}">
 <head>
 <link rel="icon" type="image/png" href="/favicon.png">
 <meta http-equiv="Content-Type" content="{quirks=application/xhtml+xml}{quirks?text/html}; charset={encoding}" />
@@ -560,7 +560,7 @@ ifdef::linkcss[]
 <script type="text/javascript">
 # Escape as CDATA to pass validators.
 /*<![CDATA[*/
-window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}
+document.addEventListener("DOMContentLoaded", function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}, false);
 /*]]>*/
 </script>
 <script type="text/javascript" src="{scriptsdir=.}/asciidoc-xhtml11.js"></script>
@@ -569,7 +569,7 @@ ifndef::linkcss[]
 <script type="text/javascript">
 # Escape as CDATA to pass validators.
 /*<![CDATA[*/
-window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}
+document.addEventListener("DOMContentLoaded", function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}, false);
 include1::{scriptsdir=./javascripts}/asciidoc-xhtml11.js[]
 /*]]>*/
 </script>
@@ -647,7 +647,7 @@ endif::doctype-manpage[]
 </div>
 {disable-javascript%<div id="footnotes"><hr /></div>}
 <div id="footer" lang="de">
-© 2009-2012 Michael Stapelberg, <a href="/impress.html">Impressum</a>
+© 2009 Michael Stapelberg, <a href="https://i3wm.org/impress.html">Impressum</a>
 </div>
 </body>
 </html>

docs/bigpicture.asy

@@ -0,0 +1,19 @@
+import drawtree;
+treeLevelStep = 2cm;
+TreeNode n94457831379296 = makeNode("``root'' (splith) []");
+TreeNode n94457831380944 = makeNode(n94457831379296, "``\_\_i3'' (output) []");
+TreeNode n94457831384048 = makeNode(n94457831380944, "``content'' (splith) []");
+TreeNode n94457831387184 = makeNode(n94457831384048, "``\_\_i3\_scratch'' (splith) []");
+TreeNode n94457831390576 = makeNode(n94457831379296, "``eDP-1'' (output) []");
+TreeNode n94457831393744 = makeNode(n94457831390576, "``topdock'' (dockarea) []");
+TreeNode n94457831396992 = makeNode(n94457831390576, "``content'' (splith) []");
+TreeNode n94457831628304 = makeNode(n94457831396992, "``1'' (splith) []");
+TreeNode n94457831571040 = makeNode(n94457831628304, "``Hacking i3: How To - Mozilla Firefox'' (leaf) []");
+TreeNode n94457831246384 = makeNode(n94457831628304, "``vim'' (leaf) []");
+TreeNode n94457831461088 = makeNode(n94457831396992, "``Named workspace'' (splith) []");
+TreeNode n94457831471424 = makeNode(n94457831461088, "``[Empty]'' (tabbed) []");
+TreeNode n94457831570576 = makeNode(n94457831471424, "``contrib/dump-asy.pl --no-gv'' (leaf) [Marks go here]");
+TreeNode n94457831645488 = makeNode(n94457831471424, "``ipython'' (leaf) []");
+TreeNode n94457831400192 = makeNode(n94457831390576, "``bottomdock'' (dockarea) []");
+TreeNode n94457831424848 = makeNode(n94457831400192, "``i3bar for output eDP-1'' (leaf) []");
+draw(n94457831379296, (0, 0));

docs/debugging

@@ -1,7 +1,7 @@
 Debugging i3: How To
 ====================
 Michael Stapelberg <michael@i3wm.org>
-December 2012
+January 2014
 
 This document describes how to debug i3 to send us useful bug
 reports, even if you have no knowledge of C programming.
@@ -10,27 +10,30 @@ Thank you for being interested in debugging i3. It really means
 something to us to get your bug fixed. If you have any questions about the
 process and/or need further help, do not hesitate to contact us!
 
-== Verify you are using the latest (development) version
+== Verify you are using i3 ≥ 4.10
 
-Please verify that you are using the latest version of i3:
+Only the latest major version of i3 is supported. To verify which version
+you are running, use:
 
 ---------------
-$ i3 --version
-i3 version 4.1.2-248-g51728ba (2012-02-12, branch "next")
+$ i3 --moreversion 2>&- || i3 --version
+Binary i3 version:  4.7 (2013-12-22, branch "tags/4.7")
+Running i3 version: 4.7-84-gac74a63 (2014-01-01, branch "next") (pid 1995)
 ---------------
 
 Your version can look like this:
 
-4.1.2 (release version)::
+4.7 (release version)::
 You are using a release version. In many cases, bugs are already
-fixed in the development version of i3. If they aren’t, we will still ask you
-to reproduce your error with the most recent development version of i3.
-Therefore, please upgrade to a development version if you can.
+fixed in the development version of i3. Even if the bug is not a known fixed
+one, we will still ask you to reproduce your error with the most recent
+development version of i3. Therefore, please upgrade to a development version
+if you can.
 
-4.1.2-248-g51728ba (development version)::
-Your version is 248 commits newer than 4.1.2, and the git revision of your
-version is +51728ba+. Go to http://code.i3wm.org/i3/commit/?h=next and see if
-the line "commit" starts with the same revision. If so, you are using the
+4.7-85-g9c15b95 (development version)::
+Your version is 85 commits newer than 4.7, and the git revision of your
+version is +9c15b95+. Go to https://github.com/i3/i3/commits/next and see if
+the most recent commit starts with the same revision. If so, you are using the
 latest version.
 
 Development versions of i3 have logging enabled by default and are compiled
@@ -57,21 +60,69 @@ list of sessions in your desktop manager (gdm, lxdm, …), edit
 Exec=i3 --shmlog-size=26214400
 ------------------------------
 
+If you cannot restart i3 for some reason, you can enable debug logging on the
+fly:
+
+---------------------------------------
+i3-msg 'debuglog on; shmlog on; reload'
+---------------------------------------
+
+== Reproducing the problem
+
+Before submitting an issue, please make sure to close down on the problem as
+much as you can yourself. Here are some steps you should consider:
+
+* Find a deterministic, reliable way to reproduce the problem and provide it
+  with your bug report.
+* Try using the default i3 config to reproduce the problem. If the issue does
+  not appear with the default config, gradually adapt it to track down what 
+  change(s) to the config introduce the problem.
+* Reproduce the problem with a minimal setup, i.e., only use as few applications,
+  windows and steps as necessary.
+* In addition, try to stick to applications that are common and, even more
+  importantly, free / open source.
+* Before obtaining the log file, restart i3 in-place, execute the steps to
+  reproduce the problem and then save the logs. This keeps the log file as
+  small as possible and necessary.
+
+Please be aware that we cannot support compatibility issues with closed-source
+software, as digging into compatibility problems without having access to the
+source code is too time-consuming. Additionally, experience has shown that
+often, the software in question is responsible for the issue. Please raise an
+issue with the software in question, not i3.
+
 == Obtaining the debug logfile
 
+[CAUTION]
+================================================================================
+Logs may contain sensitive information, so please inspect the log before
+submitting it. Logs may be viewed by anyone, once posted. If you choose to
+redact the log, make an effort not to discard information which may be relevant
+to the issue you are reporting.
+
+The best way to avoid submitting such information is to only run the necessary
+steps to reproduce the behavior when saving the log file. This will also make
+analyzing the log file easier.
+================================================================================
+
 No matter whether i3 misbehaved in some way without crashing or whether it just
 crashed, the logfile provides all information necessary to debug the problem.
 
-To save a compressed version of the logfile (suitable for attaching it to a
-bugreport), use:
---------------------------------------------------------------------
-DISPLAY=:0 i3-dump-log | gzip -9c > /tmp/i3.log.gz
---------------------------------------------------------------------
+To upload a compressed version of the logfile (for a bugreport), use:
+-------------------------------------------------------------------------------
+DISPLAY=:0 i3-dump-log | bzip2 -c | curl --data-binary @- https://logs.i3wm.org
+-------------------------------------------------------------------------------
 
 This command does not depend on i3 (it also works while i3 displays
 the crash dialog), but it requires a working X11 connection.
 
-== Compiling with debug symbols
+After running it, you will get a URL to the logfile. Please include that URL in
+your bug report.
+
+== On crashes: Obtaining a backtrace
+
+When i3 crashes, it will display a dialog stating “i3 just crashed”, offering
+you to save a backtrace to a text file.
 
 To actually get useful backtraces, you should make sure that your version of i3
 is compiled with debug symbols:
@@ -87,8 +138,6 @@ which is stripped, please check whether your distribution provides debug
 symbols (package +i3-wm-dbg+ on Debian for example) or if you can turn off
 stripping. If nothing helps, please build i3 from source.
 
-== Obtaining a backtrace
-
 Once you have made sure that your i3 is compiled with debug symbols and the C
 debugger +gdb+ is installed on your machine, you can let i3 generate a
 backtrace in the crash dialog.
@@ -98,13 +147,32 @@ After pressing "b" in the crash dialog, you will get a file called
 id (PID) and the second one is incremented each time you generate a backtrace,
 starting at 0.
 
-== Sending bug reports/debugging on IRC
+In Linux, if the backtrace just says +No stack.+, that's because gdb does not
+have necessary permissions to attach to a running process. You can fix that by
+running from a terminal (you can open a new tty, e.g. with ctrl-alt-F2):
 
-When sending bug reports, please attach the *whole* log file. Even if you think
-you found the section which clearly highlights the problem, additional
-information might be necessary to completely diagnose the problem.
+---------------------------------------------------------------------
+echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
+---------------------------------------------------------------------
 
-When debugging with us in IRC, be prepared to use a so called nopaste service
-such as http://nopaste.info or http://pastebin.com because pasting large
-amounts of text in IRC sometimes leads to incomplete lines (servers have line
-length limitations) or flood kicks.
+Afterwards, try re-generating the stack trace. Note that this setting re-sets
+after reboot, see more info at
+https://www.kernel.org/doc/Documentation/security/Yama.txt.
+
+== Debugging i3bar
+
+To debug i3bar problems, use the +--verbose+ commandline parameter,
+or add +verbose yes+ to all +bar {}+ blocks in your i3
+config, reload your config and then restart all i3bar instances like this:
+
+---------------------------------------------------------------------
+$ i3 reload
+$ killall i3bar
+$ for c in $(i3-msg -t get_bar_config | python -c \
+      'import json,sys;print("\n".join(json.load(sys.stdin)))'); do \
+    (i3bar --bar_id=$c >i3bar.$c.log 2>&1) & \
+  done;
+---------------------------------------------------------------------
+
+There will now be +i3bar.*.log+ files in your current directory that you can provide
+in your bug report.

docs/docs.mk

@@ -1,45 +0,0 @@
-DISTCLEAN_TARGETS += clean-docs
-
-# To pass additional parameters for asciidoc
-ASCIIDOC = asciidoc
-I3POD2HTML = ./docs/i3-pod2html
-
-ASCIIDOC_NOTOC_TARGETS = \
-	docs/debugging.html
-
-ASCIIDOC_TOC_TARGETS = \
-	docs/hacking-howto.html \
-	docs/userguide.html \
-	docs/ipc.html \
-	docs/multi-monitor.html \
-	docs/wsbar.html \
-	docs/testsuite.html \
-	docs/i3bar-protocol.html
-
-ASCIIDOC_TARGETS = \
-	$(ASCIIDOC_TOC_TARGETS) \
-	$(ASCIIDOC_NOTOC_TARGETS)
-
-ASCIIDOC_CALL = $(V_ASCIIDOC)$(ASCIIDOC) -n $(ASCIIDOC_FLAGS) -o $@ $<
-ASCIIDOC_TOC_CALL = $(V_ASCIIDOC)$(ASCIIDOC) -a toc -n $(ASCIIDOC_FLAGS) -o $@ $<
-
-POD2HTML_TARGETS = \
-	docs/lib-i3test.html \
-	docs/lib-i3test-test.html
-
-docs/lib-i3test.html: testcases/lib/i3test.pm
-	$(V_POD2HTML)$(I3POD2HTML) $< $@
-
-docs/lib-i3test-test.html: testcases/lib/i3test/Test.pm
-	$(V_POD2HTML)$(I3POD2HTML) $< $@
-
-docs: $(ASCIIDOC_TARGETS) $(POD2HTML_TARGETS)
-
-$(ASCIIDOC_TOC_TARGETS): docs/%.html: docs/%
-	$(ASCIIDOC_TOC_CALL)
-
-$(ASCIIDOC_NOTOC_TARGETS): docs/%.html: docs/%
-	$(ASCIIDOC_CALL)
-
-clean-docs:
-	rm -f $(ASCIIDOC_TARGETS) $(POD2HTML_TARGETS)

docs/hacking-howto

@@ -8,6 +8,71 @@ touching i3’s source code. It should contain all important information to help
 you understand why things are like they are. If it does not mention something
 you find necessary, please do not hesitate to contact me.
 
+++++
+<div style="background-color:red; color:white; padding:20px;">
+<strong style="color:white;">WARNING!</strong>
+<p>
+++++
+This document is not 100% up to date. Specifically, everything up to and
+including <<startup>> has been updated recently. The rest might contain
+outdated information.
+++++
+</p>
+</div>
+++++
+
+== Building i3
+
+You can build i3 like you build any other software package which uses
+https://mesonbuild.com/[The Meson Build system]; see
+https://mesonbuild.com/Quick-guide.html#compiling-a-meson-project[Quickstart
+Guide → Compiling a Meson project]. In case you’re unfamiliar:
+
+    mkdir -p build
+    meson setup build
+    meson compile -C build
+
+=== Build system features
+
+* +ninja test+ runs the i3 testsuite. See docs/testsuite for details.
+
+* +meson dist+ builds a release tarball and runs tests on the result.
+
+* +meson -Ddocs=true -Dmans=true+ will enable the options to build docs and
+  manpages. These options require additional dependencies that are normally not
+  required for users who just want to build i3.
+
+* +meson -Db_sanitize=address+ will enable the address sanitizer which is
+  disabled by default. A summary of memory leaks will be printed on program
+  exit. This can include false-positives. For other options of the +b_sanitize+
+  flag see https://mesonbuild.com/Builtin-options.html.
+
+== Pull requests
+
+Please talk to us before working on new features to see whether they will be
+accepted. A good way for this is to open an issue and asking for opinions on it.
+Even for accepted features, this can be a good way to refine an idea upfront.
+However, we don't want to see certain features in i3, e.g., switching window
+focus in an Alt+Tab like way.
+
+When working on bugfixes, please make sure you mention that you are working on it
+in the corresponding bug report at https://github.com/i3/i3/issues. In case there
+is no bug report yet, please create one.
+
+After you are done, please submit your work for review as a pull request at
+https://github.com/i3/i3. In order to make your review go as fast as possible,
+you could have a look at previous reviews and see what the common mistakes are.
+
+=== Which branch to use?
+
+Work on i3 generally happens in two branches: “next” (default) and “stable”.
+
+The contents of “stable” are always stable. That is, it contains the source code
+of the latest release, plus any bugfixes that were applied since that release.
+
+New features are only found in the “next” branch. Always use this branch when
+writing new code (both bugfixes and features).
+
 == Window Managers
 
 A window manager is not necessarily needed to run X, but it is usually used in
@@ -28,9 +93,9 @@ In the case of i3, the tasks (and order of them) are the following:
   the first client of X) and manage them (reparent them, create window
   decorations, etc.)
 . When new windows are created, manage them
-. Handle the client’s `_WM_STATE` property, but only `_WM_STATE_FULLSCREEN` and
-  `_NET_WM_STATE_DEMANDS_ATTENTION`
-. Handle the client’s `WM_NAME` property
+. Handle the client’s +_WM_STATE+ property, but only +_WM_STATE_FULLSCREEN+ and
+  +_NET_WM_STATE_DEMANDS_ATTENTION+
+. Handle the client’s +WM_NAME+ property
 . Handle the client’s size hints to display them proportionally
 . Handle the client’s urgency hint
 . Handle enter notifications (focus follows mouse)
@@ -45,11 +110,11 @@ will be discussed.
 
 === Tiling window managers
 
-Traditionally, there are two approaches to managing windows: The most common
-one nowadays is floating, which means the user can freely move/resize the
-windows. The other approach is called tiling, which means that your window
-manager distributes windows to use as much space as possible while not
-overlapping each other.
+Traditionally, there are two approaches to managing windows: The most common one
+nowadays is stacking (or floating, using i3's terminology), which means the user
+can freely move/resize the windows, potentially overlapping them. The other
+approach is called tiling, which means that the window manager distributes
+windows to use as much space as possible while not overlapping each other.
 
 The idea behind tiling is that you should not need to waste your time
 moving/resizing windows while you usually want to get some work done. After
@@ -78,74 +143,72 @@ workspace, the split container we are talking about is the workspace.
 
 To get an impression of how different layouts are represented, just play around
 and look at the data structures -- they are exposed as a JSON hash. See
-http://i3wm.org/docs/ipc.html#_tree_reply for documentation on that and an
+https://i3wm.org/docs/ipc.html#_tree_reply for documentation on that and an
 example.
 
 == Files
 
-include/atoms.xmacro::
-A file containing all X11 atoms which i3 uses. This file will be included
-various times (for defining, requesting and receiving the atoms), each time
-with a different definition of xmacro().
+i3's source code is in the +src+ folder while header files reside in +include+.
+Other tools such as i3bar and i3-nagbar have their own folders. i3 and its tools
+share an internal library called ``libi3'' which also has its own folder.
+
+The following list gives an overview of the codebase, explaining the
+functionality of the most important, core source code files. Other files in the
+tree that are not mentioned here implement specific functionalities: for example,
++src/scratchpad.c+ is obviously about the scratchpad functionality.
 
 include/data.h::
-Contains data definitions used by nearly all files. You really need to read
-this first.
+Contains data definitions used by nearly all files.
 
 include/*.h::
 Contains forward definitions for all public functions, as well as
 doxygen-compatible comments (so if you want to get a bit more of the big
 picture, either browse all header files or use doxygen if you prefer that).
 
-src/cfgparse.l::
-Contains the lexer for i3’s configuration file, written for +flex(1)+.
-
-src/cfgparse.y::
-Contains the parser for i3’s configuration file, written for +bison(1)+.
-
-src/click.c::
-Contains all functions which handle mouse button clicks (right mouse button
-clicks initiate resizing and thus are relatively complex).
-
-src/cmdparse.l::
-Contains the lexer for i3 commands, written for +flex(1)+.
-
-src/cmdparse.y::
-Contains the parser for i3 commands, written for +bison(1)+.
+src/config_directives.c::
+src/commands.c::
+Contain the definitions for all high-level config and command directives. These
+are excellent places to start with a top-to-bottom approach to understand
+specific i3 behavior. For example, if you want to investigate a bug that happens
+for the +move to mark+ command, you can use gdb to pause in
++cmd_move_con_to_mark+ and then work your way from there, stepping into
+lower-level functions.
 
 src/con.c::
-Contains all functions which deal with containers directly (creating
-containers, searching containers, getting specific properties from containers,
-…).
+Contains all functions which deal with containers directly (creating containers,
+searching containers, getting specific properties from containers, …). Contains
+abstractions and auxiliary functions necessary to work with the container
+structure which is used in almost all parts of the codebase.
 
-src/config.c::
-Contains all functions handling the configuration file (calling the parser
-(src/cfgparse.y) with the correct path, switching key bindings mode).
+src/tree.c::
+Contains functions which deal with the tree abstraction. However, be aware that
++src/con.c+ also contains functions that heavily interact with the tree
+structure. Some functions that are included in +str/tree.c+ are those that handle
+opening and closing containers in the tree, finding the container that should be
+focused next and flattening the tree. See also +src/move.c+ for other
+move-specific functions that interact with the tree, which were moved into their
+own file because they are so long.
 
-src/debug.c::
-Contains debugging functions to print unhandled X events.
-
-src/ewmh.c::
-Functions to get/set certain EWMH properties easily.
-
-src/floating.c::
-Contains functions for floating mode (mostly resizing/dragging).
+src/workspace.c::
+Contains functions which deal with workspaces. Includes code that creates new
+workspaces, shows existing ones and deals with workspace assignments.
 
 src/handlers.c::
 Contains all handlers for all kinds of X events (new window title, new hints,
-unmapping, key presses, button presses, …).
+unmapping, key presses, button presses, …). This is a very important file to
+understand how i3 interacts with changes to its environment.
 
-src/ipc.c::
-Contains code for the IPC interface.
+src/command_parser.c::
+src/config_parser.c::
+Contain a hand-written parser to parse commands and configuration (commands are what
+you bind on keys and what you can send to i3 using the IPC interface, like
++move left+ or +workspace 4+). +src/config.c+ is responsible for calling the
+configuration parser.
 
-src/load_layout.c::
-Contains code for loading layouts from JSON files.
-
-src/log.c::
-Contains the logging functions.
-
-src/main.c::
-Initializes the window manager.
+src/click.c::
+src/resize.c::
+Contain functions which handle mouse button clicks (right mouse button
+clicks initiate resizing and thus are relatively complex).
 
 src/manage.c::
 Looks at existing or new windows and decides whether to manage them. If so, it
@@ -154,89 +217,66 @@ reparents the window and inserts it into our data structures.
 src/match.c::
 A "match" is a data structure which acts like a mask or expression to match
 certain windows or not. For example, when using commands, you can specify a
-command like this: [title="*Firefox*"] kill. The title member of the match
+command like this: +[title="*Firefox*"] kill+. The title member of the match
 data structure will then be filled and i3 will check each window using
-match_matches_window() to find the windows affected by this command.
-
-src/move.c::
-Contains code to move a container in a specific direction.
-
-src/output.c::
-Functions to handle CT_OUTPUT cons.
++match_matches_window()+ to find the windows affected by this command.
 
 src/randr.c::
 The RandR API is used to get (and re-query) the configured outputs (monitors,
-…).
+…). Legacy Xinerama support resides in +src/xinerama.c+.
 
 src/render.c::
 Renders the tree data structure by assigning coordinates to every node. These
 values will later be pushed to X11 in +src/x.c+.
 
-src/resize.c::
-Contains the functions to resize containers.
-
 src/sighandler.c::
 Handles +SIGSEGV+, +SIGABRT+ and +SIGFPE+ by showing a dialog that i3 crashed.
-You can chose to let it dump core, to restart it in-place or to restart it
-in-place but forget about the layout.
-
-src/tree.c::
-Contains functions which open or close containers in the tree, change focus or
-cleanup ("flatten") the tree. See also +src/move.c+ for another similar
-function, which was moved into its own file because it is so long.
-
-src/util.c::
-Contains useful functions which are not really dependant on anything.
+You can choose to let it dump core and restart i3 in-place (either trying to
+preserve layout or forget about it).
 
 src/window.c::
 Handlers to update X11 window properties like +WM_CLASS+, +_NET_WM_NAME+,
 +CLIENT_LEADER+, etc.
 
-src/workspace.c::
-Contains all functions related to workspaces (displaying, hiding, renaming…)
-
-src/x.c::
-Transfers our in-memory tree (see +src/render.c+) to X11.
-
-src/xcb.c::
-Contains wrappers to use xcb more easily.
-
-src/xcursor.c::
-XCursor functions (for cursor themes).
-
-src/xinerama.c::
-Legacy support for Xinerama. See +src/randr.c+ for the preferred API.
+include/*.xmacro.*::
+A file containing all X11 atoms which i3 uses. This file will be included
+various times (for defining, requesting and receiving the atoms), each time
+with a different definition of xmacro().
 
+[[data_structures]]
 == Data structures
 
+See +include/data.h+ for documented data structures. The most important ones are
+explained here.
 
-See include/data.h for documented data structures. The most important ones are
-explained right here.
+The following picture is generated by the +contrib/dump-asy.pl+ script.
 
-/////////////////////////////////////////////////////////////////////////////////
-// TODO: update image
+image:bigpicture.png["The Big Picture",width=1000,link="bigpicture.png"]
 
-image:bigpicture.png[The Big Picture]
+The hierarchy is:
 
-/////////////////////////////////////////////////////////////////////////////////
-
-So, the hierarchy is:
-
-. *X11 root window*, the root container
-. *Output container* (LVDS1 in this example)
-. *Content container* (there are also containers for dock windows)
-. *Workspaces* (Workspace 1 in this example, with horizontal orientation)
-. *Split container* (vertically split)
-. *X11 window containers*
+. *Root container*
+. *Output containers*: +eDP-1+ in this example and the internal +__i3++ output
+. *Content and 2 dockarea containers*
+. *Workspaces*: Numbered workspace ``1'' and a ``Named workspace''
+. *Split containers*: One horizontal in the first workspace and a tabbed one in
+  the named one.
+. *Leaf containers*: Windows like vim and an i3bar dock.
 
 The data type is +Con+, in all cases.
 
-=== X11 root window
+=== Root container
 
-The X11 root window is a single window per X11 display (a display is identified
-by +:0+ or +:1+ etc.). The root window is what you draw your background image
-on. It spans all the available outputs, e.g. +VGA1+ is a specific part of the
-root window and +LVDS1+ is a specific part of the root window.
+The root container (global variable +croot+) is the up-most ascendant of every i3
+container. It can be used to iterate over the whole tree structure. E.g., it is
+used to reply to the +GET_WORKSPACES+ request, iterating over it's children to
+find all workspaces. This is different from the X11 root window.
+
+The X11 root window (global variable +root+) is a single window per X11 display
+(a display is identified by +:0+ or +:1+ etc.). The root window is what you draw
+your background image on. It spans all the available outputs, e.g. +VGA1+ is a
+specific part of the root window and +LVDS1+ is a specific part of the root
+window.
 
 === Output container
 
@@ -258,8 +298,8 @@ currently on.
 === Content container
 
 Each output has multiple children. Two of them are dock containers which hold
-dock clients. The other one is the content container, which holds the actual
-content (workspaces) of this output.
+the top and bottom dock clients. The other one is the content container, which
+holds the actual content (workspaces) of this output.
 
 === Workspace
 
@@ -278,42 +318,37 @@ vertical) and a layout.
 Split containers (and X11 window containers, which are a subtype of split
 containers) can have different border styles.
 
-=== X11 window container
+=== Leaf containers
 
-An X11 window container holds exactly one X11 window. These are the leaf nodes
-of the layout tree, they cannot have any children.
+A leaf container holds exactly one X11 window. They can't have any children.
 
 == List/queue macros
 
 i3 makes heavy use of the list macros defined in BSD operating systems. To
 ensure that the operating system on which i3 is compiled has all the expected
-features, i3 comes with `include/queue.h`. On BSD systems, you can use man
-`queue(3)`. On Linux, you have to use google (or read the source).
+features, i3 comes with +include/queue.h+. On BSD systems, you can use +man
+queue(3)+. On Linux, you have to use google (or read the source).
 
-The lists used are +SLIST+ (single linked lists), +CIRCLEQ+ (circular
-queues) and +TAILQ+ (tail queues). Usually, only forward traversal is necessary,
-so an `SLIST` works fine. If inserting elements at arbitrary positions or at
-the end of a list is necessary, a +TAILQ+ is used instead. However, for the
-windows inside a container, a +CIRCLEQ+ is necessary to go from the currently
-selected window to the window above/below.
+The lists used are +SLIST+ (single linked lists), +CIRCLEQ+ (circular queues)
+and +TAILQ+ (tail queues). Usually, +TAILQ+ is used which allows inserting
+elements at arbitrary positions or at the end of the list. If only forward
+traversal is necessary, an +SLIST+ can be used. +CIRCLEQ+ is used just to
+manage the X11 state of each window.
 
-== Naming conventions
+[[startup]]
+== Startup (src/main.c, main())
 
-There is a row of standard variables used in many events. The following names
-should be chosen for those:
-
- * ``conn'' is the xcb_connection_t
- * ``event'' is the event of the particular type
- * ``con'' names a container
- * ``current'' is a loop variable when using +TAILQ_FOREACH+ etc.
-
-== Startup (src/mainx.c, main())
+Among other things, the main() function does the following:
 
  * Establish the xcb connection
+ * Load the i3 config
  * Check for XKB extension on the separate X connection, load Xcursor
- * Check for RandR screens (with a fall-back to Xinerama)
+ * Set up EWMH hints
  * Grab the keycodes for which bindings exist
+ * Check for XRandR screens
  * Manage all existing windows
+ * Exec configured startup processes
+ * Start i3bar if configured
  * Enter the event loop
 
 == Keybindings
@@ -349,12 +384,12 @@ the correct state.
 Then, it looks through all bindings and gets the one which matches the received
 event.
 
-The bound command is parsed by the cmdparse lexer/parser, see +parse_cmd+ in
-+src/cmdparse.y+.
+The bound command is parsed by the i3 parser, see +parse_command+ in
++src/commands_parser.c+.
 
 == Manage windows (src/main.c, manage_window() and reparent_window())
 
-`manage_window()` does some checks to decide whether the window should be
++manage_window()+ does some checks to decide whether the window should be
 managed at all:
 
  * Windows have to be mapped, that is, visible on screen
@@ -362,18 +397,18 @@ managed at all:
    not be managed by a window manager
 
 Afterwards, i3 gets the initial geometry and reparents the window (see
-`reparent_window()`) if it wasn’t already managed.
++reparent_window()+) if it wasn’t already managed.
 
 Reparenting means that for each window which is reparented, a new window,
 slightly larger than the original one, is created. The original window is then
 reparented to the bigger one (called "frame").
 
-After reparenting, the window type (`_NET_WM_WINDOW_TYPE`) is checked to see
-whether this window is a dock (`_NET_WM_WINDOW_TYPE_DOCK`), like dzen2 for
+After reparenting, the window type (+_NET_WM_WINDOW_TYPE+) is checked to see
+whether this window is a dock (+_NET_WM_WINDOW_TYPE_DOCK+), like dzen2 for
 example. Docks are handled differently, they don’t have decorations and are not
 assigned to a specific container. Instead, they are positioned at the bottom
 or top of the screen (in the appropriate dock area containers). To get the
-height which needs to be reserved for the window, the `_NET_WM_STRUT_PARTIAL`
+height which needs to be reserved for the window, the +_NET_WM_STRUT_PARTIAL+
 property is used.
 
 Furthermore, the list of assignments (to other workspaces, which may be on
@@ -384,10 +419,10 @@ target workspace is not visible, the window will not be mapped.
 == What happens when an application is started?
 
 i3 does not care about applications. All it notices is when new windows are
-mapped (see `src/handlers.c`, `handle_map_request()`). The window is then
+mapped (see +src/handlers.c+, +handle_map_request()+). The window is then
 reparented (see section "Manage windows").
 
-After reparenting the window, `render_tree()` is called which renders the
+After reparenting the window, +render_tree()+ is called which renders the
 internal layout table. The new window has been placed in the currently focused
 container and therefore the new window and the old windows (if any) need to be
 moved/resized so that the currently active layout (default/stacking/tabbed mode)
@@ -403,10 +438,14 @@ can reconfigure themselves).
 
 == _NET_WM_STATE
 
-Only the _NET_WM_STATE_FULLSCREEN atom is handled. It calls
-``toggle_fullscreen()'' for the specific client which just configures the
-client to use the whole screen on which it currently is. Also, it is set as
-fullscreen_client for the i3Screen.
+Only the _NET_WM_STATE_FULLSCREEN and _NET_WM_STATE_DEMANDS_ATTENTION atoms
+are handled.
+
+The former calls +toggle_fullscreen()+ for the specific client which just
+configures the client to use the whole screen on which it currently is.
+Also, it is set as fullscreen_client for the i3Screen.
+
+The latter is used to set, read and display urgency hints.
 
 == WM_NAME
 
@@ -459,7 +498,7 @@ container) to the bottom.
 
 === Rendering the root container
 
-The i3 root container (`con->type == CT_ROOT`) represents the X11 root window.
+The i3 root container (+con->type == CT_ROOT+) represents the X11 root window.
 It contains one child container for every output (like LVDS1, VGA1, …), which
 is available on your computer.
 
@@ -478,7 +517,7 @@ only called for the global fullscreen window.
 
 === Rendering an output
 
-Output containers (`con->layout == L_OUTPUT`) represent a hardware output like
+Output containers (+con->layout == L_OUTPUT+) represent a hardware output like
 LVDS1, VGA1, etc. An output container has three children (at the moment): One
 content container (having workspaces as children) and the top/bottom dock area
 containers.
@@ -486,7 +525,7 @@ containers.
 The rendering happens in the function +render_l_output()+ in the following
 steps:
 
-1. Find the content container (`con->type == CT_CON`)
+1. Find the content container (+con->type == CT_CON+)
 2. Get the currently visible workspace (+con_get_fullscreen_con(content,
    CF_OUTPUT)+).
 3. If there is a fullscreened window on that workspace, directly render it and
@@ -494,24 +533,22 @@ steps:
 4. Sum up the space used by all the dock windows (they have a variable height
    only).
 5. Set the workspace rects (x/y/width/height) based on the position of the
-   output (stored in `con->rect`) and the usable space
-   (`con->rect.{width,height}` without the space used for dock windows).
+   output (stored in +con->rect+) and the usable space
+   (+con->rect.{width,height}+ without the space used for dock windows).
 6. Recursively raise and render the output’s child containers (meaning dock
    area containers and the content container).
 
 === Rendering a workspace or split container
 
 From here on, there really is no difference anymore. All containers are of
-`con->type == CT_CON` (whether workspace or split container) and some of them
-have a `con->window`, meaning they represent an actual window instead of a
++con->type == CT_CON+ (whether workspace or split container) and some of them
+have a +con->window+, meaning they represent an actual window instead of a
 split container.
 
 ==== Default layout
 
 In default layout, containers are placed horizontally or vertically next to
-each other (depending on the `con->orientation`). If a child is a leaf node (as
-opposed to a split container) and has border style "normal", appropriate space
-will be reserved for its window decoration.
+each other (depending on the +con->orientation+).
 
 ==== Stacked layout
 
@@ -588,7 +625,7 @@ optimize this and call +x_push_node+ on the appropriate con directly.
    itself for the container’s children. This function actually pushes the
    state, see the next paragraph.
 4. If the pointer needs to be warped to a different position (for example when
-   changing focus to a differnt output), it will be warped now.
+   changing focus to a different output), it will be warped now.
 5. The eventmask is restored for all mapped windows.
 6. Window decorations will be rendered by calling +x_deco_recurse+ on the root
    container, which then recursively calls itself for the children.
@@ -628,8 +665,8 @@ unmapped if it should not be visible anymore. +WM_STATE+ will be set to
 +x_draw_decoration+ draws window decorations. It is run for every leaf
 container (representing an actual X11 window) and for every non-leaf container
 which is in a stacked/tabbed container (because stacked/tabbed containers
-display a window decoration for split containers, which at the moment just says
-"another container").
+display a window decoration for split containers, which consists of a representation
+of the child container's names.
 
 Then, parameters are collected to be able to determine whether this decoration
 drawing is actually necessary or was already done. This saves a substantial
@@ -685,9 +722,9 @@ all commands.
 In earlier versions of i3, interpreting these commands was done using lex and
 yacc, but experience has shown that lex and yacc are not well suited for our
 command language. Therefore, starting from version 4.2, we use a custom parser
-for user commands (not yet for the configuration file).
+for user commands and the configuration file.
 The input specification for this parser can be found in the file
-+parser-specs/commands.spec+. Should you happen to use Vim as an editor, use
++parser-specs/*.spec+. Should you happen to use Vim as an editor, use
 :source parser-specs/highlighting.vim to get syntax highlighting for this file
 (highlighting files for other editors are welcome).
 
@@ -728,11 +765,14 @@ features. This is its definition:
 # workspace next|prev|next_on_output|prev_on_output
 # workspace back_and_forth
 # workspace <name>
+# workspace number <number>
 state WORKSPACE:
   direction = 'next_on_output', 'prev_on_output', 'next', 'prev'
       -> call cmd_workspace($direction)
   'back_and_forth'
       -> call cmd_workspace_back_and_forth()
+  'number'
+      -> WORKSPACE_NUMBER
   workspace = string
       -> call cmd_workspace_name($workspace)
 ----------------------------------------------------------------
@@ -752,8 +792,8 @@ workspace <direction>::
 	the beginning. +
 
 NOTE: Note that you can specify multiple literals in the same line. This has
-	exactly the same effect as if you specified `direction =
-	'next_on_output' -> call cmd_workspace($direction)` and so forth. +
+	exactly the same effect as if you specified +direction =
+	'next_on_output' -> call cmd_workspace($direction)+ and so forth. +
 
 NOTE: Also note that the order of literals is important here: If 'next' were
 	ordered before 'next_on_output', then 'next_on_output' would never
@@ -771,6 +811,10 @@ workspace <name>::
 	single quotes), but just called string. Other possible tokens are word
 	(the same as string, but stops matching at a whitespace) and end
 	(matches the end of the input).
+workspace number <number>::
+        The workspace command has to be followed by the keyword +number+. It
+        then transitions into the state +WORKSPACE_NUMBER+, where the actual
+        parameter will be read.
 
 === Introducing a new command
 
@@ -838,7 +882,7 @@ empty.
 Afterwards, +con_focus+ will be called to fix the focus stack and the tree will
 be flattened.
 
-=== Case 3: Moving to non-existant top/bottom
+=== Case 3: Moving to non-existent top/bottom
 
 Like in case 1, the reference layout for this case is a single workspace in
 horizontal orientation with two containers on it. Focus is on the left
@@ -865,7 +909,7 @@ container and the container above/below the current one (on the level of
 Now, +con_focus+ will be called to fix the focus stack and the tree will be
 flattened.
 
-=== Case 4: Moving to existant top/bottom
+=== Case 4: Moving to existent top/bottom
 
 The reference layout for this case is a vertical workspace with two containers.
 The bottom one is a h-split containing two containers (1 and 2). Focus is on
@@ -933,49 +977,15 @@ Without much ado, here is the list of cases which need to be considered:
 
 == Gotchas
 
-* Forgetting to call `xcb_flush(conn);` after sending a request. This usually
+* Forgetting to call +xcb_flush(conn);+ after sending a request. This usually
   leads to code which looks like it works fine but which does not work under
   certain conditions.
 
-* Forgetting to call `floating_fix_coordinates(con, old_rect, new_rect)` after
+* Forgetting to call +floating_fix_coordinates(con, old_rect, new_rect)+ after
   moving workspaces across outputs. Coordinates for floating containers are
   not relative to workspace boundaries, so you must correct their coordinates
   or those containers will show up in the wrong workspace or not at all.
 
-== Using git / sending patches
-
-=== Introduction
-
-For a short introduction into using git, see
-http://web.archive.org/web/20121024222556/http://www.spheredev.org/wiki/Git_for_the_lazy
-or, for more documentation, see http://git-scm.com/documentation
-
-Please talk to us before working on new features to see whether they will be
-accepted. There are a few things which we don’t want to see in i3, e.g. a
-command which will focus windows in an alt+tab like way.
-
-When working on bugfixes, please make sure you mention that you are working on
-it in the corresponding bugreport at http://bugs.i3wm.org/. In case there is no
-bugreport yet, please create one.
-
-After you are done, please submit your work for review at http://cr.i3wm.org/
-
-Do not send emails to the mailing list or any author directly, and don’t submit
-them in the bugtracker, since all reviews should be done in public at
-http://cr.i3wm.org/. In order to make your review go as fast as possible, you
-could have a look at previous reviews and see what the common mistakes are.
-
-=== Which branch to use?
-
-Work on i3 generally happens in two branches: “master” and “next”. Since
-“master” is what people get when they check out the git repository, its
-contents are always stable. That is, it contains the source code of the latest
-release, plus any bugfixes that were applied since that release.
-
-New features are only found in the “next” branch. Therefore, if you are working
-on a new feature, use the “next” branch. If you are working on a bugfix, use
-the “next” branch, too, but make sure your code also works on “master”.
-
 == Thought experiments
 
 In this section, we collect thought experiments, so that we don’t forget our
@@ -1011,7 +1021,7 @@ gets started in any way) and the window(s) which appear.
 
 Imagine for example using dmenu: The user starts dmenu by pressing Mod+d, dmenu
 gets started with PID 3390. The user then decides to launch Firefox, which
-takes a long time. So he enters firefox into dmenu and presses enter. Firefox
+takes a long time. So they enter firefox into dmenu and press enter. Firefox
 gets started with PID 4001. When it finally finishes loading, it creates an X11
 window and uses MapWindow to make it visible. This is the first time i3
 actually gets in touch with Firefox. It decides to map the window, but it has

docs/i3-pod2html

@@ -4,8 +4,14 @@
 use strict;
 use warnings;
 use Pod::Simple::HTML;
+use Getopt::Long;
 use v5.10;
 
+my $stylesurl = '';
+
+GetOptions("stylesurl=s" => \$stylesurl)
+  or die "parsing flags";
+
 $Pod::Simple::HTML::Tagmap{'Verbatim'} = '<pre><tt>';
 $Pod::Simple::HTML::Tagmap{'VerbatimFormatted'} = '<pre><tt>';
 $Pod::Simple::HTML::Tagmap{'/Verbatim'} = '</tt></pre>';
@@ -22,8 +28,9 @@ open(my $out, '>', $ARGV[1]) or die "Couldn’t open $ARGV[1] for writing: $!\n"
 my $parser = Pod::Simple::HTML->new();
 
 $parser->index(1);
-$parser->html_header_before_title(
-<<'EOF'
+if ($stylesurl ne '') {
+    $parser->html_header_before_title(
+<<EOF
 <!doctype html>
 <html lang="en">
 <head>
@@ -31,7 +38,7 @@ $parser->html_header_before_title(
 <meta charset="utf-8">
 <meta name="generator" content="Pod::Simple::HTML">
 <meta name="description" content="i3 Perl documentation">
-<link rel="stylesheet" href="http://i3wm.org/css/style.css" type="text/css" />
+<link rel="stylesheet" href="$stylesurl/style.css" type="text/css" />
 <style type="text/css">
 .pod pre {
     background: #333;
@@ -63,7 +70,8 @@ tt {
 </style>
 <title>
 EOF
-);
+    );
+}
 $parser->html_header_after_title(
 <<'EOF'
 </title>
@@ -75,9 +83,9 @@ $parser->html_header_after_title(
 			<ul id="nav">
 				<li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>
 				<li><a href="/screenshots">Screens</a></li>
-				<li><a href="http://faq.i3wm.org/">FAQ</a></li>
+				<li><a href="https://www.github.com/i3/i3/discussions">Get Help</a></li>
 				<li><a href="/contact">Contact</a></li>
-				<li><a href="http://bugs.i3wm.org/">Bugs</a></li>
+				<li><a href="https://bugs.i3wm.org/">Bugs</a></li>
 			</ul>
 	<br style="clear: both">
 <div id="content" class="pod">

docs/i3bar-protocol

@@ -6,7 +6,7 @@ August 2012
 This document explains the protocol in which i3bar expects its input. It
 provides support for colors, urgency, shortening and easy manipulation.
 
-== Rationale for chosing JSON
+== Rationale for choosing JSON
 
 Before describing the protocol, let’s cover why JSON is a building block of
 this protocol.
@@ -96,30 +96,32 @@ i3status and others will output single statuslines in one line, separated by
 
 You can find an example of a shell script which can be used as your
 +status_command+ in the bar configuration at
-http://code.stapelberg.de/git/i3/tree/contrib/trivial-bar-script.sh?h=next
+https://github.com/i3/i3/blob/next/contrib/trivial-bar-script.sh
 
 === Header in detail
 
 version::
 	The version number (as an integer) of the i3bar protocol you will use.
 stop_signal::
-	Specify to i3bar the signal (as an integer) to send to stop your
-	processing.
-	The default value (if none is specified) is SIGSTOP.
+	Specify the signal (as an integer) that i3bar should send to request that you
+	pause your output. This is used to conserve battery power when the bar is
+	hidden by not unnecessarily computing bar updates. The default value is SIGSTOP,
+	which will unconditionally stop your process. If this is an issue, this feature
+	can be disabled by setting the value to 0.
 cont_signal::
-	Specify to i3bar the signal (as an integer)to send to continue your
+	Specify to i3bar the signal (as an integer) to send to continue your
 	processing.
 	The default value (if none is specified) is SIGCONT.
 click_events::
-	If specified and true i3bar will write a infinite array (same as above)
+	If specified and true i3bar will write an infinite array (same as above)
 	to your stdin.
 
 === Blocks in detail
 
 full_text::
-	The most simple block you can think of is one which just includes the
-	only required key, the +full_text+ key. i3bar will display the string
-	value and that’s it.
+	The +full_text+ will be displayed by i3bar on the status line. This is the
+	only required key. If +full_text+ is an empty string, the block will be
+	skipped.
 short_text::
 	Where appropriate, the +short_text+ (string) entry should also be
 	provided. It will be used in case the status line needs to be shortened
@@ -137,6 +139,22 @@ color::
 	when it is associated.
 	Colors are specified in hex (like in HTML), starting with a leading
 	hash sign. For example, +#ff0000+ means red.
+background::
+	Overrides the background color for this particular block.
+border::
+	Overrides the border color for this particular block.
+border_top::
+        Defines the width (in pixels) of the top border of this block. Defaults
+        to 1.
+border_right::
+        Defines the width (in pixels) of the right border of this block. Defaults
+        to 1.
+border_bottom::
+        Defines the width (in pixels) of the bottom border of this block. Defaults
+        to 1.
+border_left::
+        Defines the width (in pixels) of the left border of this block. Defaults
+        to 1.
 min_width::
 	The minimum width (in pixels) of the block. If the content of the
 	+full_text+ key take less space than the specified min_width, the block
@@ -148,7 +166,7 @@ min_width::
         when you want to set a sensible minimum width regardless of which font you
         are using, and at what particular size.
 align::
-	Align text on the +center+ (default), +right+ or +left+ of the block, when
+	Align text on the +center+, +right+ or +left+ (default) of the block, when
 	the minimum width of the latter, specified by the +min_width+ key, is not
 	reached.
 name and instance::
@@ -171,6 +189,11 @@ separator_block_width::
 	this gap, a separator line will be drawn unless +separator+ is
 	disabled. Normally, you want to set this to an odd value (the default
 	is 9 pixels), since the separator line is drawn in the middle.
+markup::
+	A string that indicates how the text of the block should be parsed. Set to
+	+"pango"+ to use https://developer.gnome.org/pango/1.46/[Pango markup].
+	Set to +"none"+ to not use any markup (default). Pango markup only works
+	if you use a pango font.
 
 If you want to put in your own entries into a block, prefix the key with an
 underscore (_). i3bar will ignore all keys it doesn’t understand, and prefixing
@@ -204,13 +227,20 @@ An example of a block which uses all possible entries follows:
  "full_text": "E: 10.0.0.1 (1000 Mbit/s)",
  "short_text": "10.0.0.1",
  "color": "#00ff00",
+ "background": "#1c1c1c",
+ "border": "#ee0000",
+ "border_top": 1,
+ "border_right": 0,
+ "border_bottom": 3,
+ "border_left": 1,
  "min_width": 300,
  "align": "right",
  "urgent": false,
  "name": "ethernet",
  "instance": "eth0",
  "separator": true,
- "separator_block_width": 9
+ "separator_block_width": 9,
+ "markup": "none"
 }
 ------------------------------------------
 
@@ -224,9 +254,19 @@ name::
 instance::
 	Instance of the block, if set
 x, y::
-	X11 root window coordinates where the click occured
-button:
+	X11 root window coordinates where the click occurred
+button::
 	X11 button ID (for example 1 to 3 for left/middle/right mouse button)
+relative_x, relative_y::
+    Coordinates where the click occurred, with respect to the top left corner
+    of the block
+output_x, output_y::
+    Coordinates relative to the current output where the click occurred
+width, height::
+    Width and height (in px) of the block
+modifiers::
+    An array of the modifiers active when the click occurred. The order in which
+    modifiers are listed is not guaranteed.
 
 *Example*:
 ------------------------------------------
@@ -234,7 +274,14 @@ button:
  "name": "ethernet",
  "instance": "eth0",
  "button": 1,
- "x": 1320,
- "y": 1400
+ "modifiers": ["Shift", "Mod1"],
+ "x": 1925,
+ "y": 1400,
+ "relative_x": 12,
+ "relative_y": 8,
+ "output_x": 5,
+ "output_y": 1400,
+ "width": 50,
+ "height": 22
 }
 ------------------------------------------

docs/i3bar-workspace-protocol

@@ -0,0 +1,184 @@
+i3bar workspace buttons protocol
+================================
+
+This document explains the protocol in which i3bar expects input for
+configuring workspace buttons. This feature is available since i3 version 4.23.
+
+The program defined by the +workspace_command+ configuration option for i3bar can
+modify the workspace buttons displayed by i3bar. The command should constantly
+print in its standard output a stream of messages following the protocol
+defined in this page.
+
+If you are looking for the status line protocol instead, see https://i3wm.org/docs/i3bar-protocol.html.
+
+== The protocol
+
+Each message should be a newline-delimited JSON array. The array is in the same
+format as the +GET_WORKSPACES+ ipc event, see
+https://i3wm.org/docs/ipc.html#_workspaces_reply.
+
+As an example, this is the output of the +i3-msg -t get_workspaces+ command:
+------------------------------
+[
+  {
+    "id": 94131549984064,
+    "num": 1,
+    "name": "1",
+    "visible": false,
+    "focused": false,
+    "output": "HDMI-A-0",
+    "urgent": false
+  },
+  {
+    "id": 94131550477584,
+    "num": 2,
+    "name": "2",
+    "visible": true,
+    "focused": true,
+    "output": "HDMI-A-0",
+    "urgent": false
+  },
+  {
+    "id": 94131550452704,
+    "num": 3,
+    "name": "3:some workspace",
+    "visible": false,
+    "focused": false,
+    "output": "HDMI-A-0",
+    "urgent": false
+  }
+]
+------------------------------
+
+Please note that this example was pretty printed for human consumption, with
+the +"rect"+ field removed. Workspace button commands should output each array
+in one line.
+
+Each element in the array represents a workspace. i3bar creates one workspace
+button for each element in the array. The order of these buttons is the same as
+the order of the elements in the array.
+
+In general, we recommend subscribing to the +workspace+ and +output+
+https://i3wm.org/docs/ipc.html#_workspace_event[events],
+fetching the current workspace information with +GET_WORKSPACES+, modifying the
+JSON array in the response according to your needs and then printing it to the
+standard output. However, you are free to build a new message from the ground
+up.
+
+=== Workspace objects in detail
+
+The documentation of +GET_WORKSPACES+ should be sufficient to understand the
+meaning of each property but here we provide extra notes for each property and
+its meaning with respect to i3bar.
+
+All properties but +name+ are optional.
+
+id (integer)::
+    If it is included it will be used to switch to that workspace when you
+    click the corresponding button. If it's not provided, the +name+ will be
+    used. You can use the +id+ field to present workspaces under a modified
+    name.
+num (integer)::
+    The only use of a workspace's number is if the +strip_workspace_numbers+
+    setting is enabled.
+name (string)::
+    The only required property. If an +id+ is provided you can freely change
+    the +name+ as you wish, effectively renaming the buttons of i3bar.
+visible (boolean)::
+    Defaults to +false+ if not included. +focused+ takes precedence over it,
+    however +visible+ is important for more than one monitor.
+focused (boolean)::
+    Defaults to +false+ if not included. Generally, exactly one of the
+    workspaces should be +focused+. If not, no button will have the
+    +focused_workspace+ color.
+urgent (boolean)::
+    Defaults to +false+ if not included.
+rect (map)::
+    Not used by i3bar but will be ignored.
+output (string)::
+    Defaults to the primary output if not included.
+
+== Examples
+
+These example scripts require the https://stedolan.github.io/jq/[jq] utility to
+be installed but otherwise just use the standard +i3-msg+ utility included with
+i3. However, you can write your own scripts in your preferred language, with
+the help of one of the
+https://i3wm.org/docs/ipc.html#_see_also_existing_libraries[pre-existing i3
+libraries]
+
+=== Base configuration
+
+------------------------------
+bar {
+  …
+  workspace_command /path/to/your/script.sh
+  …
+}
+------------------------------
+
+=== Re-create the default behaviour of i3bar
+
+Not very useful by itself but this will be the basic building block of all the
+following scripts. This one does not require +jq+.
+
+------------------------------
+#!/bin/sh
+i3-msg -t subscribe -m '["workspace", "output"]' | {
+    # Initially print the current workspaces before we receive any events. This
+    # avoids having an empty bar when starting up.
+    i3-msg -t get_workspaces;
+    # Then, while we receive events, update the workspace information.
+    while read EVENT; do i3-msg -t get_workspaces; done;
+}
+------------------------------
+
+=== Hide workspace named +foo+ unless if it is focused.
+
+------------------------------
+#!/bin/sh
+i3-msg -t subscribe -m '["workspace", "output"]' | {
+    i3-msg -t get_workspaces;
+    while read EVENT; do i3-msg -t get_workspaces; done;
+} | jq --unbuffered -c '[ .[] | select(.name != "foo" or .focused) ]'
+------------------------------
+
+Important! Make sure you use the +--unbuffered+ flag with +jq+, otherwise you
+might not get the changes in real-time but whenever they are flushed, which
+might mean that you are getting an empty bar until enough events are written.
+
+=== Show empty workspaces +foo+ and +bar+ on LVDS1 even if they do not exist at the moment.
+
+------------------------------
+#!/bin/sh
+i3-msg -t subscribe -m '["workspace", "output"]' | {
+    i3-msg -t get_workspaces;
+    while read EVENT; do i3-msg -t get_workspaces; done;
+} | jq --unbuffered -c '
+    def fake_ws(name): {
+        name: name,
+        output: "LVDS1",
+    };
+    . + [ fake_ws("foo"), fake_ws("bar") ] | unique_by(.name)
+'
+------------------------------
+
+=== Sort workspaces in reverse alphanumeric order
+
+------------------------------
+#!/bin/sh
+i3-msg -t subscribe -m '["workspace", "output"]' | {
+    i3-msg -t get_workspaces;
+    while read EVENT; do i3-msg -t get_workspaces; done;
+} | jq --unbuffered -c 'sort_by(.name) | reverse'
+------------------------------
+
+=== Append "foo" to the name of each workspace
+
+------------------------------
+#!/bin/sh
+i3-msg -t subscribe -m '["workspace", "output"]' | {
+    i3-msg -t get_workspaces;
+    while read EVENT; do i3-msg -t get_workspaces; done;
+} | jq --unbuffered -c '[ .[] | .name |= . + " foo" ]'
+------------------------------

docs/layout-saving

@@ -0,0 +1,263 @@
+Layout saving in i3
+===================
+Michael Stapelberg <michael@i3wm.org>
+April 2014
+
+Layout saving/restoring is a feature that was introduced in i3 v4.8.
+
+Layout saving/restoring allows you to load a JSON layout file so that you can
+have a base layout to start working with after powering on your computer.
+Dynamic use-cases also come to mind: if you frequently (but not always!) need a
+grid layout of terminals with ping/traceroute commands to diagnose network
+issues, you can easily automate opening these windows in just the right layout.
+
+== Saving the layout
+
+You can save the layout of either a single workspace or an entire output (e.g.
+LVDS1). Of course, you can repeat this step multiple times if you want to
+save/restore multiple workspaces/outputs.
+
++i3-save-tree(1)+ is a tool to save the layout. It will print a JSON
+representation of i3’s internal layout data structures to stdout. Typically,
+you may want to take a quick look at the output, then save it to a file and
+tweak it a little bit:
+
+---------------------------------------------------
+i3-save-tree --workspace 1 > ~/.i3/workspace-1.json
+---------------------------------------------------
+
+Please note that the output of +i3-save-tree(1)+ is *NOT useful* until you
+manually modify it — you need to tell i3 how to match/distinguish windows (for
+example based on their WM_CLASS, title, etc.). By default, all the different
+window properties are included in the output, but commented out. This is partly
+to avoid relying on heuristics and partly to make you aware how i3 works so
+that you can easily solve layout restoring problems.
+
+How to modify the file manually is described in <<EditingLayoutFiles>>.
+
+== Restoring the layout
+
+After restoring the example layout from <<EditingLayoutFiles>>, i3 will open
+placeholder windows for all the windows that were specified in the layout file.
+You can recognize the placeholder windows by the watch symbol
+footnote:[Depending on the font you are using, a placeholder symbol may show up
+instead of the watch symbol.] in the center of the window, and by the swallow
+criteria specification at the top of the window:
+
+image:layout-saving-1.png["Restored layout",width=400,link="layout-saving-1.png"]
+
+When an application opens a window that matches the specified swallow criteria,
+it will be placed in the corresponding placeholder window. We say it gets
+*swallowed* by the placeholder container, hence the term.
+
+Note: Swallowing windows into unsatisfied placeholder windows takes precedence
+over
+link:https://i3wm.org/docs/userguide.html#_automatically_putting_clients_on_specific_workspaces[assignment
+rules]. For example, if you assign all Emacs windows to workspace 1 in your i3
+configuration file, but there is a placeholder window on workspace 2 which
+matches Emacs as well, your newly started Emacs window will end up in the
+placeholder window on workspace 2.
+
+The placeholder windows are just regular windows, so feel free to move them
+around or close them, for example.
+
+=== append_layout command
+
+The +append_layout+ command is used to load a layout file into i3. It accepts a
+path (relative to i3’s current working directory or absolute) to a JSON file.
+
+*Syntax*:
+--------------------------------------------------------------------------------
+append_layout <path>
+--------------------------------------------------------------------------------
+
+*Examples*:
+--------------------------------------------------------------------------------
+# From a terminal or script:
+i3-msg "workspace 1; append_layout /home/michael/.i3/workspace-1.json"
+
+# In your i3 configuration file, you can autostart i3-msg like this:
+# (Note that those lines will quickly become long, so typically you would store
+#  them in a script with proper indentation.)
+exec --no-startup-id "i3-msg 'workspace 1; append_layout /home/michael/.i3/workspace-1.json'"
+--------------------------------------------------------------------------------
+
+== Editing layout files
+
+[[EditingLayoutFiles]]
+
+=== Anatomy of a layout file
+
+Here is an example layout file that we’ll discuss:
+
+--------------------------------------------------------------------------------
+{
+    // splitv split container with 2 children
+    "layout": "splitv",
+    "percent": 0.4,
+    "type": "con",
+    "nodes": [
+        {
+            "border": "none",
+            "name": "irssi",
+            "percent": 0.5,
+            "type": "con",
+            "swallows": [
+                {
+                    "class": "^URxvt$",
+                    "instance": "^irssi$"
+                }
+            ]
+        },
+        {
+            // stacked split container with 2 children
+            "layout": "stacked",
+            "percent": 0.5,
+            "type": "con",
+            "nodes": [
+                {
+                    "name": "notmuch",
+                    "percent": 0.5,
+                    "type": "con",
+                    "swallows": [
+                        {
+                            "class": "^Emacs$",
+                            "instance": "^notmuch$"
+                        }
+                    ]
+                },
+                {
+                    "name": "midna: ~",
+                    "percent": 0.5,
+                    "type": "con"
+                }
+            ]
+        }
+    ]
+}
+
+{
+    // stacked split container with 1 children
+    "layout": "stacked",
+    "percent": 0.6,
+    "type": "con",
+    "nodes": [
+        {
+            "name": "chrome",
+            "type": "con",
+            "swallows": [
+                {
+                    "class": "^Google-chrome$"
+                }
+            ]
+        }
+    ]
+}
+--------------------------------------------------------------------------------
+
+In this layout, the screen is divided into two columns. In the left column,
+which covers 40% of the screen, there is a terminal emulator running irssi on
+the top, and a stacked split container with an Emacs window and a terminal
+emulator on the bottom. In the right column, there is a stacked container with
+a Chrome window:
+
+image:layout-saving-1.png["Restored layout",width=400,link="layout-saving-1.png"]
+
+The structure of this JSON file looks a lot like the +TREE+ reply, see
+https://build.i3wm.org/docs/ipc.html#_tree_reply for documentation on that. Some
+properties are excluded because they are not relevant when restoring a layout.
+
+Most importantly, look at the "swallows" section of each window. This is where
+you need to be more or less specific. As an example, remember the section about
+the Emacs window:
+
+--------------------------------------------------------------------------------
+"swallows": [
+    {
+        "class": "^Emacs$",
+        "instance": "^notmuch$"
+    }
+]
+--------------------------------------------------------------------------------
+
+Here you can see that i3 will require both the class and the instance to match.
+Therefore, if you just start Emacs via dmenu, it will not get swallowed by that
+container. Only if you start Emacs with the proper instance name (+emacs24
+--name notmuch+), it will get swallowed.
+
+You can match on "class", "instance", "window_role", "title" and "machine". All
+values are case-sensitive regular expressions (PCRE). Use +xprop(1)+ and click
+into a window to see its properties:
+
+--------------------------------------------------------------------------------
+$ xprop
+WM_WINDOW_ROLE(STRING) = "gimp-toolbox-color-dialog"
+WM_CLASS(STRING) = "gimp-2.8", "Gimp-2.8"
+_NET_WM_NAME(UTF8_STRING) = "Change Foreground Color"
+--------------------------------------------------------------------------------
+
+The first part of +WM_CLASS+ is the "instance" (gimp-2.8 in this case), the
+second part is the "class" (Gimp-2.8 in this case). "title" matches against
++_NET_WM_NAME+ and "window_role" matches against +WM_WINDOW_ROLE+.
+
+In general, you should try to be as specific as possible in your swallow
+criteria. Try to use criteria that match one window and only one window, to
+have a reliable startup procedure.
+
+If you specify multiple swallow criteria, the placeholder will be replaced by
+the window which matches any of the criteria. As an example:
+
+--------------------------------------------------------------------------------
+// Matches either Emacs or Gvim, whichever one is started first.
+"swallows": [
+    {"class": "^Emacs$"},
+    {"class": "^Gvim$"}
+]
+--------------------------------------------------------------------------------
+
+=== JSON standard non-compliance
+
+A layout file as generated by +i3-save-tree(1)+ is not strictly valid JSON:
+
+1. Layout files contain multiple “JSON texts” at the top level. The JSON
+   standard doesn't prohibit this, but in practice most JSON parsers only
+   allow precisely one “text” per document/file, and will mark multiple texts
+   as invalid JSON.
+
+2. Layout files contain comments which are not allowed by the JSON standard,
+   but are understood by many parsers.
+
+Both of these deviations from the norm are to make manual editing by humans
+easier. In case you are writing a more elaborate tool for manipulating these
+layouts, you can either use a JSON parser that supports these deviations (for
+example libyajl), transform the layout file to a JSON-conforming file, or
+link:https://github.com/i3/i3/blob/next/.github/CONTRIBUTING.md[submit a patch]
+to make +i3-save-tree(1)+ optionally output standard-conforming JSON.
+
+== Troubleshooting
+
+=== Restoring a vertically split workspace
+
+When using +i3-save-tree+ with the +--workspace+ switch, only the *contents* of
+the workspace will be dumped. This means that properties of the workspace
+itself will be lost.
+
+This is relevant for, e.g., a vertically split container as the base container of
+a workspace. Since the split mode is a property of the workspace, it will not be
+stored. In this case, you will have to manually wrap your layout in such a
+container:
+
+--------------------------------------------------------------------------------
+// vim:ts=4:sw=4:et
+{
+    // this is a manually added container to restore the vertical split
+    "layout": "splitv",
+    "percent": 0.5,
+    "type": "con",
+    "nodes": [
+
+        // the dumped workspace layout goes here
+
+    ]
+}
+--------------------------------------------------------------------------------

docs/refcard.html

@@ -15,7 +15,7 @@
 		h1 { font-size: 1.1em; }
 		header a { font-size: 0.7em; }
 		header p { margin: 5px 0; font-size: 0.8em; text-align: left; }
-		kbd { font-family: LinuxBiolinumKeyboard, Linux Biolinum Keyboard O, Linux Biolinum Keyboard, DejaVu Sans Mono, monospace; font-size: 0.9em; }
+		kbd { font-family: LinuxBiolinumKeyboard, Linux Biolinum Keyboard O, Linux Biolinum Keyboard, DejaVu Sans Mono, monospace; font-size: 1.2em; }
 		code { font-family: DejaVu Sans Mono, monospace; font-size: 0.8em; }
 		section { break-inside: avoid-column; -moz-break-inside: -moz-avoid-column; -webkit-break-inside: avoid-column; }
 		h2 { margin: 7px 0 2px; padding: 2px 4px; font-size: 1.1em; font-family: LinuxBiolinum, Linux Biolinum O, Linux Biolinum, sans; background-color: #b3b3b3; }
@@ -34,7 +34,7 @@
 	<header>
 		<img id="logo" src="logo-30.png" alt="" />
 		<h1>i3 Reference Card</h1>
-		<a href="http://i3wm.org/docs/userguide.html">http://i3wm.org/docs/userguide.html</a>
+		<a href="https://i3wm.org/docs/userguide.html">https://i3wm.org/docs/userguide.html</a>
 		<p>
 			Throughout this guide, the i3 logo will be used to refer to the configured modifier.
 			This is the <kbd></kbd> key (<code>Mod1</code>) by default,

docs/testsuite

@@ -4,11 +4,10 @@ Michael Stapelberg <michael@i3wm.org>
 September 2012
 
 This document explains how the i3 testsuite works, how to use it and extend it.
-It is targeted at developers who not necessarily have been doing testing before
-or have not been testing in Perl before. In general, the testsuite is not of
+It is targeted at developers who haven't necessarily done testing before,
+or have not used Perl for testing before. In general, the testsuite is not of
 interest for end users.
 
-
 == Introduction
 
 The i3 testsuite is a collection of files which contain testcases for various
@@ -37,14 +36,14 @@ that, but it will also be useful for every future change.
 
 Apart from this document, you should also have a look at:
 
-1. The "Modern Perl" book, which can be found at
-   http://onyxneon.com/books/modern_perl/modern_perl_a4.pdf
+1. The "Modern Perl" book:
+   https://i3wm.org/downloads/modern_perl_a4.pdf
 2. The latest Perl documentation of the "i3test" (general testcase setup) and
    "i3test::Test" (additional test instructions) modules:
-   http://build.i3wm.org/docs/lib-i3test.html respectively
-   http://build.i3wm.org/docs/lib-i3test-test.html
+   https://build.i3wm.org/docs/lib-i3test.html respectively
+   https://build.i3wm.org/docs/lib-i3test-test.html
 3. The latest documentation on i3’s IPC interface:
-   http://build.i3wm.org/docs/ipc.html
+   https://build.i3wm.org/docs/ipc.html
 
 == Implementation
 
@@ -74,24 +73,23 @@ client, simply called +cpan+. It comes with every Perl installation and can be
 used to install the testsuite. Many users prefer to use the more modern
 +cpanminus+ instead, though (because it asks no questions and just works):
 
-.Installing testsuite dependencies using cpanminus (preferred)
---------------------------------------------------------------------------------
-$ cd ~/i3/testcases
-$ sudo apt-get install cpanminus
-$ sudo cpanm .
---------------------------------------------------------------------------------
+The tests additionally require +Xephyr(1)+ to run a nested X server. Install
++xserver-xephyr+ on Debian or +xorg-server-xephyr+ on Arch Linux.
 
-If you don’t want to use cpanminus for some reason, the same works with cpan:
-
-.Installing testsuite dependencies using cpan
+.Installing testsuite dependencies using cpanminus
 --------------------------------------------------------------------------------
-$ cd ~/i3/testcases
-$ sudo cpan .
+# Install testsuite system-level dependencies. Xvfb is optional but recommended.
+$ sudo apt-get install xcb-proto cpanminus xvfb xserver-xephyr
+# Install dependencies in ~/perl5 local library
+$ cpanm --local-lib=~/perl5 local::lib App::cpanminus Module::Install
+# Activate the local library
+$ eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)
+$ cd ~/i3/testcases/
+$ cpanm .
+$ cd ~/i3/AnyEvent-I3
+$ cpanm .
 --------------------------------------------------------------------------------
 
-In case you don’t have root permissions, you can also install into your home
-directory, see http://michael.stapelberg.de/cpan/
-
 === Mechanisms
 
 ==== Script: complete-run
@@ -102,11 +100,22 @@ more testcases. Also, it takes care of starting up a separate instance of i3
 with an appropriate configuration file and creates a folder for each run
 containing the appropriate i3 logfile for each testcase. The latest folder can
 always be found under the symlink +latest/+. Unless told differently, it will
-run the tests on a separate X server instance (using the Xdummy script).
+run the tests on a separate X server instance (using Xephyr).
 
-.Example invocation of complete-run.pl+
+Xephyr will open a window where you can inspect the running test. By default,
+tests are run under Xvfb.
+
+.Example invocation of +complete-run.pl+
 ---------------------------------------
-$ cd ~/i3/testcases
+$ cd ~/i3
+
+$ mkdir -p build
+
+$ meson setup build
+$ cd build
+
+$ meson compile
+# output omitted because it is very long
 
 $ ./complete-run.pl
 # output omitted because it is very long
@@ -114,44 +123,104 @@ All tests successful.
 Files=78, Tests=734, 27 wallclock secs ( 0.38 usr  0.48 sys + 17.65 cusr  3.21 csys = 21.72 CPU)
 Result: PASS
 
-$ ./complete-run.pl t/04-floating.t
-[:3] i3 startup: took 0.07s, status = 1
-[:3] Running t/04-floating.t with logfile testsuite-2011-09-24-16-06-04-4.0.2-226-g1eb011a/i3-log-for-04-floating.t
-[:3] t/04-floating.t finished
-[:3] killing i3
-output for t/04-floating.t:
-ok 1 - use X11::XCB::Window;
-ok 2 - The object isa X11::XCB::Window
-ok 3 - Window is mapped
-ok 4 - i3 raised the width to 75
-ok 5 - i3 raised the height to 50
-ok 6 - i3 did not map it to (0x0)
-ok 7 - The object isa X11::XCB::Window
-ok 8 - i3 let the width at 80
-ok 9 - i3 let the height at 90
-ok 10 - i3 mapped it to x=1
-ok 11 - i3 mapped it to y=18
-ok 12 - The object isa X11::XCB::Window
-ok 13 - i3 let the width at 80
-ok 14 - i3 let the height at 90
-1..14
+$ ./complete-run.pl t/005-floating.t
+Running tests under Xvfb display :99
+Starting 1 Xephyr instances, starting at :100...
+
+Rough time estimate for this run: 9.65 seconds
+
+Writing logfile to 'testsuite-2024-05-01-21-33-45-4.23-28-g5834b7e8/complete-run.log'...
+[:100] i3/testcases/t/005-floating.t: finished
+completed 0 of 1 tests
 
 All tests successful.
-Files=1, Tests=14,  0 wallclock secs ( 0.01 usr  0.00 sys +  0.19 cusr  0.03 csys =  0.23 CPU)
+Files=1, Tests=13,  0 wallclock secs ( 0.00 usr +  0.00 sys =  0.00 CPU)
 Result: PASS
 
-$ less latest/i3-log-for-04-floating.t
+The slowest tests are:
+	i3/testcases/t/005-floating.t with 0.07 seconds
+
+Test output:
+[:100] i3/testcases/t/005-floating.t: starting
+[:100] i3/testcases/t/005-floating.t: finished
+output for i3/testcases/t/005-floating.t:
+ok 1 - An object of class 'X11::XCB::Window' isa 'X11::XCB::Window'
+ok 2 - Window is mapped
+ok 3 - i3 raised the width to 75
+ok 4 - i3 raised the height to 50
+ok 5 - i3 did not map it to (0x0)
+ok 6 - An object of class 'X11::XCB::Window' isa 'X11::XCB::Window'
+ok 7 - i3 let the width at 80
+ok 8 - i3 let the height at 90
+ok 9 - i3 mapped it to x=20
+ok 10 - i3 mapped it to y=20
+ok 11 - An object of class 'X11::XCB::Window' isa 'X11::XCB::Window'
+ok 12 - i3 let the width at 80
+ok 13 - i3 let the height at 90
+1..13
+
+$ less latest/i3-log-for-005-floating.t
 ----------------------------------------
 
 If your attempt to run the tests with a bare call to ./complete-run.pl fails, try this:
 
 ---------------------------------------------------
-$ ./complete-run.pl --parallel=1 --keep-xdummy-output
+$ ./complete-run.pl --parallel=1 --keep-xserver-output
 ---------------------------------------------------
 
-One common cause of failures is not having the X dummy server module
-installed.  Under Debian and Ubuntu this is the package
-+xserver-xorg-video-dummy+.
+This will show the output of Xephyr, which is the X server implementation we
+use for testing.
+
+===== ninja command: +ninja test+
++ninja test+ runs the i3 testsuite.
+You can still use ./complete-run.pl to get the interactive progress output.
+
+.Example invocation of +ninja test+
+---------------------------------------
+$ cd ~/i3
+
+$ mkdir -p build
+
+$ meson setup build
+$ cd build
+
+$ ninja test
+[1/102] Generating config.h with a custom command
+[1/2] Running all tests.
+1/1 complete-run OK              34.39s
+
+Ok:                 1
+Expected Fail:      0
+Fail:               0
+Unexpected Pass:    0
+Skipped:            0
+Timeout:            0
+
+Full log written to i3/build/meson-logs/testlog.txt
+
+$ less latest/complete-run.log
+----------------------------------------
+
+==== Coverage testing
+
+Coverage testing is possible with +lcov+, the front-end for GCC's coverage
+testing tool +gcov+. The testcases can generate a nice html report that tells
+you which functions and lines were covered during a run of the tests. You can
+use this tool to judge how effective your tests are.
+
+To use test coverage tools, first compile with coverage enabled.
+
+---------------------------------------------------
+COVERAGE=1 make
+---------------------------------------------------
+
+Then run the tests with the +--coverage-testing+ flag.
+
+---------------------------------------------------
+./complete-run.pl --coverage-testing
+---------------------------------------------------
+
+Then open +latest/i3-coverage/index.html+ in your web browser.
 
 ==== IPC interface
 
@@ -160,7 +229,7 @@ interface which i3 provides. It is used for the startup process of i3, for
 terminating it cleanly and (most importantly) for modifying and getting the
 current state (layout tree).
 
-See [http://i3wm.org/docs/ipc.html] for documentation on the IPC interface.
+See [https://i3wm.org/docs/ipc.html] for documentation on the IPC interface.
 
 ==== X11::XCB
 
@@ -168,17 +237,16 @@ In order to open new windows, change attributes, get events, etc., the
 testsuite uses X11::XCB, a new (and quite specific to i3 at the moment) Perl
 module which uses the XCB protocol description to generate Perl bindings to
 X11. They work in a very similar way to libxcb (which i3 uses) and provide
-relatively high-level interfaces (objects such as +X11::XCB::Window+) aswell as
+relatively high-level interfaces (objects such as +X11::XCB::Window+) as well as
 access to the low-level interface, which is very useful when testing a window
 manager.
 
 === Filesystem structure
 
 In the git root of i3, the testcases live in the folder +testcases+. This
-folder contains the +complete-run.pl+ and +Xdummy+ scripts and a base
-configuration file which will be used for the tests. The different testcases
-(their file extension is .t, not .pl) themselves can be found in the
-conventionally named subfolder +t+:
+folder contains the +complete-run.pl+ and a base configuration file which will
+be used for the tests. The different testcases (their file extension is .t, not
+.pl) themselves can be found in the conventionally named subfolder +t+:
 
 .Filesystem structure
 --------------------------------------------
@@ -197,7 +265,6 @@ conventionally named subfolder +t+:
 │   │   ├── omitted for brevity
 │   │   ├── ...
 │   │   └── 74-regress-focus-toggle.t
-│   └── Xdummy
 --------------------------------------------
 
 == Anatomy of a testcase
@@ -409,7 +476,7 @@ an i3 crash resulting in the testcase being unable to communicate with i3 via
 IPC anymore.
 
 [[i3_sync]]
-== Appendix A: The i3 sync protocol
+== Appendix A: The I3_SYNC protocol
 
 Consider the following situation: You open two windows in your testcase, then
 you use +focus left+ and want to verify that the X11 focus has been updated
@@ -424,12 +491,12 @@ cmd 'focus left';
 is($x->input_focus, $left->id, 'left window focused');
 ----------
 
-However, the test fails. Sometimes. Apparantly, there is a race condition in
+However, the test fails. Sometimes. Apparently, there is a race condition in
 your test. If you think about it, this is because you are using two different
 pieces of software: You tell i3 to update focus, i3 confirms that, and then you
-ask X11 to give you the current focus. There is a certain time i3 needs to
-update the X11 state. If the testcase gets CPU time before X11 processed i3's
-requests, the test will fail.
+ask X11 to give you the current focus. There is a certain time that the X11
+server needs to process the requests from i3. If the testcase's request for the
+input focus is processed before i3's requests, the test will fail.
 
 image::i3-sync.png["Diagram of the race condition", title="Diagram of the race condition"]
 
@@ -459,10 +526,10 @@ less robust.
 
 The real solution for this problem is a mechanism which I call "the i3 sync
 protocol". The idea is to send a request (which does not modify state) via X11
-to i3 which will then be answered. Due to the request's position in the event
-queue (*after* all previous events), you can be sure that by the time you
-receive the reply, all other events have been dealt with by i3 (and, more
-importantly, X11).
+to i3 which will then be answered, again via X11. Because this answer is
+generated via an X11 request, it will be sent to the X11 server *after* all
+previous requests. Thus, you can be sure that by the time you receive the reply,
+all other events have been dealt with by i3 (and, more importantly, X11).
 
 image::i3-sync-working.png["Diagram of the i3 sync solution", title="Diagram of the i3 sync solution"]
 
@@ -497,7 +564,35 @@ i3 will then reply with the same ClientMessage, sent to the window specified in
 request. You should use a random value in +data[1]+ and check that you received
 the same one when getting the reply.
 
-== Appendix B: Socket activation
+== Appendix B: The sync IPC command
+
+The above I3_SYNC protocol allows to synchronise with i3. However, it is not
+enough for tests that also involve i3bar: There might still be messages from
+i3bar in-flight even after synchronising with i3. Thus, there also exists a sync
+IPC command, that is however not meant to be used directly. Instead, i3bar uses
+it for implementing the I3_SYNC protocol.
+
+The intended usage works like this:
+
+1. You send an I3_SYNC message to i3bar's window. See <<i3_sync>>.
+2. i3bar sends a SYNC IPC command to i3 with payload
+   +{"window":your-window-here,"rnd":your-random-value}+.
+3. i3 reacts to this IPC command as if it received an I3_SYNC request via X11.
+
+This protocol is used, for example, in t/525-i3bar-mouse-bindings.t: A mouse
+button press on i3bar is triggered. i3bar reacts to this by sending IPC commands
+to i3.
+
+The necessary synchronisation is achieved by sending an I3_SYNC event to i3bar:
+Because i3bar reacts with a sync IPC command to i3, all previous IPC commands from
+i3bar will be handled first. Because i3 reacts via X11, all previous X11
+requests from i3 will be handled by the X11 server first.
+
+The actual test also has to sync with i3 first due to how X11 handling works.
+For more details, refer to the documentation for +XAllowEvents+ with mode
++ReplayPointer+.
+
+== Appendix C: Socket activation
 
 Socket activation is a mechanism which was made popular by systemd, an init
 replacement. It basically describes creating a listening socket before starting
@@ -588,7 +683,7 @@ activation, we decreased the total amount of time necessary to run all tests
 it significantly more attractive to run the test suite more often (or at all)
 during development.
 
-An alternative approach to using socket activation is polling for the existance
+An alternative approach to using socket activation is polling for the existence
 of the IPC socket and connecting to it. While this might be slightly easier to
 implement, it wastes CPU time and is considerably uglier than this solution
 :). After all, +lib/SocketActivation.pm+ contains only 54 SLOC.

docs/wsbar

@@ -48,7 +48,7 @@ will be adjusted properly.
 
 +i3-wsbar+ used to be the reference implementation before we had +i3bar+.
 Nowadays, it is not shipped with release tarballs, but you can still get it at
-http://code.stapelberg.de/git/i3/tree/contrib/i3-wsbar
+https://github.com/i3/i3/blob/next/contrib/i3-wsbar
 
 === The big picture
 

etc/config

@@ -0,0 +1,214 @@
+# i3 config file (v4)
+#
+# Please see https://i3wm.org/docs/userguide.html for a complete reference!
+#
+# This config file uses keycodes (bindsym) and was written for the QWERTY
+# layout.
+#
+# To get a config file with the same key positions, but for your current
+# layout, use the i3-config-wizard
+#
+
+# Font for window titles. Will also be used by the bar unless a different font
+# is used in the bar {} block below.
+font pango:monospace 8
+
+# This font is widely installed, provides lots of unicode glyphs, right-to-left
+# text rendering and scalability on retina/hidpi displays (thanks to pango).
+#font pango:DejaVu Sans Mono 8
+
+# Start XDG autostart .desktop files using dex. See also
+# https://wiki.archlinux.org/index.php/XDG_Autostart
+exec --no-startup-id dex --autostart --environment i3
+
+# The combination of xss-lock, nm-applet and pactl is a popular choice, so
+# they are included here as an example. Modify as you see fit.
+
+# xss-lock grabs a logind suspend inhibit lock and will use i3lock to lock the
+# screen before suspend. Use loginctl lock-session to lock your screen.
+exec --no-startup-id xss-lock --transfer-sleep-lock -- i3lock --nofork
+
+# NetworkManager is the most popular way to manage wireless networks on Linux,
+# and nm-applet is a desktop environment-independent system tray GUI for it.
+exec --no-startup-id nm-applet
+
+# Use pactl to adjust volume in PulseAudio.
+set $refresh_i3status killall -SIGUSR1 i3status
+bindsym XF86AudioRaiseVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ +10% && $refresh_i3status
+bindsym XF86AudioLowerVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ -10% && $refresh_i3status
+bindsym XF86AudioMute exec --no-startup-id pactl set-sink-mute @DEFAULT_SINK@ toggle && $refresh_i3status
+bindsym XF86AudioMicMute exec --no-startup-id pactl set-source-mute @DEFAULT_SOURCE@ toggle && $refresh_i3status
+
+# use these keys for focus, movement, and resize directions when reaching for
+# the arrows is not convenient
+set $up l
+set $down k
+set $left j
+set $right semicolon
+
+# use Mouse+Mod1 to drag floating windows to their wanted position
+floating_modifier Mod1
+
+# move tiling windows via drag & drop by left-clicking into the title bar,
+# or left-clicking anywhere into the window while holding the floating modifier.
+tiling_drag modifier titlebar
+
+# start a terminal
+bindsym Mod1+Return exec i3-sensible-terminal
+
+# kill focused window
+bindsym Mod1+Shift+q kill
+
+# start dmenu (a program launcher)
+bindsym Mod1+d exec --no-startup-id dmenu_run
+# A more modern dmenu replacement is rofi:
+# bindsym Mod1+d exec "rofi -modi drun,run -show drun"
+# There also is i3-dmenu-desktop which only displays applications shipping a
+# .desktop file. It is a wrapper around dmenu, so you need that installed.
+# bindsym Mod1+d exec --no-startup-id i3-dmenu-desktop
+
+# change focus
+bindsym Mod1+$left focus left
+bindsym Mod1+$down focus down
+bindsym Mod1+$up focus up
+bindsym Mod1+$right focus right
+
+# alternatively, you can use the cursor keys:
+bindsym Mod1+Left focus left
+bindsym Mod1+Down focus down
+bindsym Mod1+Up focus up
+bindsym Mod1+Right focus right
+
+# move focused window
+bindsym Mod1+Shift+$left move left
+bindsym Mod1+Shift+$down move down
+bindsym Mod1+Shift+$up move up
+bindsym Mod1+Shift+$right move right
+
+# alternatively, you can use the cursor keys:
+bindsym Mod1+Shift+Left move left
+bindsym Mod1+Shift+Down move down
+bindsym Mod1+Shift+Up move up
+bindsym Mod1+Shift+Right move right
+
+# split in horizontal orientation
+bindsym Mod1+h split h
+
+# split in vertical orientation
+bindsym Mod1+v split v
+
+# enter fullscreen mode for the focused container
+bindsym Mod1+f fullscreen toggle
+
+# change container layout (stacked, tabbed, toggle split)
+bindsym Mod1+s layout stacking
+bindsym Mod1+w layout tabbed
+bindsym Mod1+e layout toggle split
+
+# toggle tiling / floating
+bindsym Mod1+Shift+space floating toggle
+
+# change focus between tiling / floating windows
+bindsym Mod1+space focus mode_toggle
+
+# focus the parent container
+bindsym Mod1+a focus parent
+
+# focus the child container
+#bindsym Mod1+d focus child
+
+# move the currently focused window to the scratchpad
+bindsym Mod1+Shift+minus move scratchpad
+
+# Show the next scratchpad window or hide the focused scratchpad window.
+# If there are multiple scratchpad windows, this command cycles through them.
+bindsym Mod1+minus scratchpad show
+
+# Define names for default workspaces for which we configure key bindings later on.
+# We use variables to avoid repeating the names in multiple places.
+set $ws1 "1"
+set $ws2 "2"
+set $ws3 "3"
+set $ws4 "4"
+set $ws5 "5"
+set $ws6 "6"
+set $ws7 "7"
+set $ws8 "8"
+set $ws9 "9"
+set $ws10 "10"
+
+# switch to workspace
+bindsym Mod1+1 workspace number $ws1
+bindsym Mod1+2 workspace number $ws2
+bindsym Mod1+3 workspace number $ws3
+bindsym Mod1+4 workspace number $ws4
+bindsym Mod1+5 workspace number $ws5
+bindsym Mod1+6 workspace number $ws6
+bindsym Mod1+7 workspace number $ws7
+bindsym Mod1+8 workspace number $ws8
+bindsym Mod1+9 workspace number $ws9
+bindsym Mod1+0 workspace number $ws10
+
+# move focused container to workspace
+bindsym Mod1+Shift+1 move container to workspace number $ws1
+bindsym Mod1+Shift+2 move container to workspace number $ws2
+bindsym Mod1+Shift+3 move container to workspace number $ws3
+bindsym Mod1+Shift+4 move container to workspace number $ws4
+bindsym Mod1+Shift+5 move container to workspace number $ws5
+bindsym Mod1+Shift+6 move container to workspace number $ws6
+bindsym Mod1+Shift+7 move container to workspace number $ws7
+bindsym Mod1+Shift+8 move container to workspace number $ws8
+bindsym Mod1+Shift+9 move container to workspace number $ws9
+bindsym Mod1+Shift+0 move container to workspace number $ws10
+
+# reload the configuration file
+bindsym Mod1+Shift+c reload
+# restart i3 inplace (preserves your layout/session, can be used to upgrade i3)
+bindsym Mod1+Shift+r restart
+# exit i3 (logs you out of your X session)
+bindsym Mod1+Shift+e exec "i3-nagbar -t warning -m 'You pressed the exit shortcut. Do you really want to exit i3? This will end your X session.' -B 'Yes, exit i3' 'i3-msg exit'"
+
+# resize window (you can also use the mouse for that)
+mode "resize" {
+        # These bindings trigger as soon as you enter the resize mode
+
+        # Pressing left will shrink the window’s width.
+        # Pressing right will grow the window’s width.
+        # Pressing up will shrink the window’s height.
+        # Pressing down will grow the window’s height.
+        bindsym $left       resize shrink width 10 px or 10 ppt
+        bindsym $down       resize grow height 10 px or 10 ppt
+        bindsym $up         resize shrink height 10 px or 10 ppt
+        bindsym $right      resize grow width 10 px or 10 ppt
+
+        # same bindings, but for the arrow keys
+        bindsym Left        resize shrink width 10 px or 10 ppt
+        bindsym Down        resize grow height 10 px or 10 ppt
+        bindsym Up          resize shrink height 10 px or 10 ppt
+        bindsym Right       resize grow width 10 px or 10 ppt
+
+        # back to normal: Enter or Escape or Mod1+r
+        bindsym Return mode "default"
+        bindsym Escape mode "default"
+        bindsym Mod1+r mode "default"
+}
+
+bindsym Mod1+r mode "resize"
+
+# Start i3bar to display a workspace bar (plus the system information i3status
+# finds out, if available)
+bar {
+        status_command i3status
+}
+
+#######################################################################
+# automatically start i3-config-wizard to offer the user to create a
+# keysym-based config which used their favorite modifier (alt or windows)
+#
+# i3-config-wizard will not launch if there already is a config file
+# in ~/.config/i3/config (or $XDG_CONFIG_HOME/i3/config if set) or
+# ~/.i3/config.
+#
+# Please remove the following exec line:
+#######################################################################
+exec i3-config-wizard

etc/config.keycodes

@@ -0,0 +1,189 @@
+# WARNING
+# WARNING: This configuration file is a template for the i3-config-wizard to
+# WARNING: generate a config which uses keysyms in your current layout. It does
+# WARNING: not get loaded by i3. Please do not change it.
+# WARNING
+
+# i3 config file (v4)
+#
+# Please see https://i3wm.org/docs/userguide.html for a complete reference!
+
+set $mod Mod1
+
+# Font for window titles. Will also be used by the bar unless a different font
+# is used in the bar {} block below.
+font pango:monospace 8
+
+# This font is widely installed, provides lots of unicode glyphs, right-to-left
+# text rendering and scalability on retina/hidpi displays (thanks to pango).
+#font pango:DejaVu Sans Mono 8
+
+# Start XDG autostart .desktop files using dex. See also
+# https://wiki.archlinux.org/index.php/XDG_Autostart
+exec --no-startup-id dex --autostart --environment i3
+
+# The combination of xss-lock, nm-applet and pactl is a popular choice, so
+# they are included here as an example. Modify as you see fit.
+
+# xss-lock grabs a logind suspend inhibit lock and will use i3lock to lock the
+# screen before suspend. Use loginctl lock-session to lock your screen.
+exec --no-startup-id xss-lock --transfer-sleep-lock -- i3lock --nofork
+
+# NetworkManager is the most popular way to manage wireless networks on Linux,
+# and nm-applet is a desktop environment-independent system tray GUI for it.
+exec --no-startup-id nm-applet
+
+# Use pactl to adjust volume in PulseAudio.
+set $refresh_i3status killall -SIGUSR1 i3status
+bindsym XF86AudioRaiseVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ +10% && $refresh_i3status
+bindsym XF86AudioLowerVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ -10% && $refresh_i3status
+bindsym XF86AudioMute exec --no-startup-id pactl set-sink-mute @DEFAULT_SINK@ toggle && $refresh_i3status
+bindsym XF86AudioMicMute exec --no-startup-id pactl set-source-mute @DEFAULT_SOURCE@ toggle && $refresh_i3status
+
+# Use Mouse+$mod to drag floating windows to their wanted position
+floating_modifier $mod
+
+# move tiling windows via drag & drop by left-clicking into the title bar,
+# or left-clicking anywhere into the window while holding the floating modifier.
+tiling_drag modifier titlebar
+
+# start a terminal
+bindcode $mod+36 exec i3-sensible-terminal
+
+# kill focused window
+bindcode $mod+Shift+24 kill
+
+# start dmenu (a program launcher)
+bindcode $mod+40 exec --no-startup-id dmenu_run
+# A more modern dmenu replacement is rofi:
+# bindcode $mod+40 exec "rofi -modi drun,run -show drun"
+# There also is i3-dmenu-desktop which only displays applications shipping a
+# .desktop file. It is a wrapper around dmenu, so you need that installed.
+# bindcode $mod+40 exec --no-startup-id i3-dmenu-desktop
+
+# change focus
+bindcode $mod+44 focus left
+bindcode $mod+45 focus down
+bindcode $mod+46 focus up
+bindcode $mod+47 focus right
+
+# alternatively, you can use the cursor keys:
+bindcode $mod+113 focus left
+bindcode $mod+116 focus down
+bindcode $mod+111 focus up
+bindcode $mod+114 focus right
+
+# move focused window
+bindcode $mod+Shift+44 move left
+bindcode $mod+Shift+45 move down
+bindcode $mod+Shift+46 move up
+bindcode $mod+Shift+47 move right
+
+# alternatively, you can use the cursor keys:
+bindcode $mod+Shift+113 move left
+bindcode $mod+Shift+116 move down
+bindcode $mod+Shift+111 move up
+bindcode $mod+Shift+114 move right
+
+# split in horizontal orientation
+bindcode $mod+43 split h
+
+# split in vertical orientation
+bindcode $mod+55 split v
+
+# enter fullscreen mode for the focused container
+bindcode $mod+41 fullscreen toggle
+
+# change container layout (stacked, tabbed, toggle split)
+bindcode $mod+39 layout stacking
+bindcode $mod+25 layout tabbed
+bindcode $mod+26 layout toggle split
+
+# toggle tiling / floating
+bindcode $mod+Shift+65 floating toggle
+
+# change focus between tiling / floating windows
+bindcode $mod+65 focus mode_toggle
+
+# focus the parent container
+bindcode $mod+38 focus parent
+
+# focus the child container
+#bindsym $mod+d focus child
+
+# Define names for default workspaces for which we configure key bindings later on.
+# We use variables to avoid repeating the names in multiple places.
+set $ws1 "1"
+set $ws2 "2"
+set $ws3 "3"
+set $ws4 "4"
+set $ws5 "5"
+set $ws6 "6"
+set $ws7 "7"
+set $ws8 "8"
+set $ws9 "9"
+set $ws10 "10"
+
+# switch to workspace
+bindcode $mod+10 workspace number $ws1
+bindcode $mod+11 workspace number $ws2
+bindcode $mod+12 workspace number $ws3
+bindcode $mod+13 workspace number $ws4
+bindcode $mod+14 workspace number $ws5
+bindcode $mod+15 workspace number $ws6
+bindcode $mod+16 workspace number $ws7
+bindcode $mod+17 workspace number $ws8
+bindcode $mod+18 workspace number $ws9
+bindcode $mod+19 workspace number $ws10
+
+# move focused container to workspace
+bindcode $mod+Shift+10 move container to workspace number $ws1
+bindcode $mod+Shift+11 move container to workspace number $ws2
+bindcode $mod+Shift+12 move container to workspace number $ws3
+bindcode $mod+Shift+13 move container to workspace number $ws4
+bindcode $mod+Shift+14 move container to workspace number $ws5
+bindcode $mod+Shift+15 move container to workspace number $ws6
+bindcode $mod+Shift+16 move container to workspace number $ws7
+bindcode $mod+Shift+17 move container to workspace number $ws8
+bindcode $mod+Shift+18 move container to workspace number $ws9
+bindcode $mod+Shift+19 move container to workspace number $ws10
+
+# reload the configuration file
+bindcode $mod+Shift+54 reload
+# restart i3 inplace (preserves your layout/session, can be used to upgrade i3)
+bindcode $mod+Shift+27 restart
+# exit i3 (logs you out of your X session)
+bindcode $mod+Shift+26 exec "i3-nagbar -t warning -m 'You pressed the exit shortcut. Do you really want to exit i3? This will end your X session.' -B 'Yes, exit i3' 'i3-msg exit'"
+
+# resize window (you can also use the mouse for that)
+mode "resize" {
+        # These bindings trigger as soon as you enter the resize mode
+
+        # Pressing left will shrink the window’s width.
+        # Pressing right will grow the window’s width.
+        # Pressing up will shrink the window’s height.
+        # Pressing down will grow the window’s height.
+        bindcode 44 resize shrink width 10 px or 10 ppt
+        bindcode 45 resize grow height 10 px or 10 ppt
+        bindcode 46 resize shrink height 10 px or 10 ppt
+        bindcode 47 resize grow width 10 px or 10 ppt
+
+        # same bindings, but for the arrow keys
+        bindcode 113 resize shrink width 10 px or 10 ppt
+        bindcode 116 resize grow height 10 px or 10 ppt
+        bindcode 111 resize shrink height 10 px or 10 ppt
+        bindcode 114 resize grow width 10 px or 10 ppt
+
+        # back to normal: Enter or Escape or $mod+r
+        bindcode 36 mode "default"
+        bindcode 9 mode "default"
+        bindcode $mod+27 mode "default"
+}
+
+bindcode $mod+27 mode "resize"
+
+# Start i3bar to display a workspace bar (plus the system information i3status
+# finds out, if available)
+bar {
+        status_command i3status
+}

generate-command-parser.pl

@@ -1,8 +1,8 @@
 #!/usr/bin/env perl
 # vim:ts=4:sw=4:expandtab
 #
-# i3 - an improved dynamic tiling window manager
-# © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
+# i3 - an improved tiling window manager
+# © 2009 Michael Stapelberg and contributors (see also: LICENSE)
 #
 # generate-command-parser.pl: script to generate parts of the command parser
 # from its specification file parser-specs/commands.spec.
@@ -65,7 +65,7 @@ for my $line (@raw_lines) {
 my $current_state;
 
 for my $line (@lines) {
-    if (my ($state) = ($line =~ /^state ([A-Z_]+):$/)) {
+    if (my ($state) = ($line =~ /^state ([A-Z0-9_]+):$/)) {
         #say "got a new state: $state";
         $current_state = $state;
     } else {
@@ -77,7 +77,7 @@ for my $line (@lines) {
             ($line =~ /
                 ^\s*                  # skip leading whitespace
                 ([a-z_]+ \s* = \s*|)  # optional identifier
-                (.*?) -> \s*          # token 
+                (.*?) -> \s*          # token
                 (.*)                  # optional action
              /x);
 
@@ -109,30 +109,31 @@ for my $line (@lines) {
 # Second step: Generate the enum values for all states.
 
 # It is important to keep the order the same, so we store the keys once.
-# We sort descendingly by length to be able to replace occurences of the state
+# We sort descendingly by length to be able to replace occurrences of the state
 # name even when one state’s name is included in another one’s (like FOR_WINDOW
 # is in FOR_WINDOW_COMMAND).
-my @keys = sort { length($b) <=> length($a) } keys %states;
+my @keys = sort { (length($b) <=> length($a)) or ($a cmp $b) } keys %states;
 
 open(my $enumfh, '>', "GENERATED_${prefix}_enums.h");
 
-# XXX: we might want to have a way to do this without a trailing comma, but gcc
-# seems to eat it.
 my %statenum;
+say $enumfh '#pragma once';
 say $enumfh 'typedef enum {';
 my $cnt = 0;
 for my $state (@keys, '__CALL') {
-    say $enumfh "    $state = $cnt,";
+    say $enumfh ',' if $cnt > 0;
+    print $enumfh "    $state = $cnt";
     $statenum{$state} = $cnt;
     $cnt++;
 }
-say $enumfh '} cmdp_state;';
+say $enumfh "\n} cmdp_state;";
 close($enumfh);
 
 # Third step: Generate the call function.
 open(my $callfh, '>', "GENERATED_${prefix}_call.h");
-my $resultname = uc(substr($prefix, 0, 1)) . substr($prefix, 1) . 'Result';
-say $callfh "static void GENERATED_call(const int call_identifier, struct $resultname *result) {";
+my $resultname = uc(substr($prefix, 0, 1)) . substr($prefix, 1) . 'ResultIR';
+say $callfh '#pragma once';
+say $callfh "static void GENERATED_call(Match *current_match, struct stack *stack, const int call_identifier, struct $resultname *result) {";
 say $callfh '    switch (call_identifier) {';
 my $call_id = 0;
 for my $state (@keys) {
@@ -149,26 +150,34 @@ for my $state (@keys) {
         # calls to get_string(). Also replaces state names (like FOR_WINDOW)
         # with their ID (useful for cfg_criteria_init(FOR_WINDOW) e.g.).
         $cmd =~ s/$_/$statenum{$_}/g for @keys;
-        $cmd =~ s/\$([a-z_]+)/get_string("$1")/g;
-        $cmd =~ s/\&([a-z_]+)/get_long("$1")/g;
+        $cmd =~ s/\$([a-z_]+)/get_string(stack, "$1")/g;
+        $cmd =~ s/\&([a-z_]+)/get_long(stack, "$1")/g;
         # For debugging/testing, we print the call using printf() and thus need
         # to generate a format string. The format uses %d for <number>s,
         # literal numbers or state IDs and %s for NULL, <string>s and literal
         # strings.
+
+        # remove the function name temporarily, so that the following
+        # replacements only apply to the arguments.
+        my ($funcname) = ($fmt =~ /^(.+)\(/);
+        $fmt =~ s/^$funcname//;
+
         $fmt =~ s/$_/%d/g for @keys;
         $fmt =~ s/\$([a-z_]+)/%s/g;
         $fmt =~ s/\&([a-z_]+)/%ld/g;
         $fmt =~ s/"([a-z0-9_]+)"/%s/g;
         $fmt =~ s/(?:-?|\b)[0-9]+\b/%d/g;
 
+        $fmt = $funcname . $fmt;
+
         say $callfh "         case $call_id:";
         say $callfh "             result->next_state = $next_state;";
         say $callfh '#ifndef TEST_PARSER';
         my $real_cmd = $cmd;
         if ($real_cmd =~ /\(\)/) {
-            $real_cmd =~ s/\(/(&current_match, result/;
+            $real_cmd =~ s/\(/(current_match, result/;
         } else {
-            $real_cmd =~ s/\(/(&current_match, result, /;
+            $real_cmd =~ s/\(/(current_match, result, /;
         }
         say $callfh "             $real_cmd;";
         say $callfh '#else';
@@ -199,6 +208,7 @@ close($callfh);
 # Fourth step: Generate the token datastructures.
 
 open(my $tokfh, '>', "GENERATED_${prefix}_tokens.h");
+say $tokfh '#pragma once';
 
 for my $state (@keys) {
     my $tokens = $states{$state};
@@ -211,13 +221,22 @@ for my $state (@keys) {
             # quote of the literal. We can do strdup(literal + 1); then :).
             $token_name =~ s/'$//;
         }
+        # Escape double quotes:
+        $token_name =~ s,",\\",g;
         my $next_state = $token->{next_state};
         if ($next_state =~ /^call /) {
             ($call_identifier) = ($next_state =~ /^call ([0-9]+)$/);
             $next_state = '__CALL';
         }
-        my $identifier = $token->{identifier};
-        say $tokfh qq|    { "$token_name", "$identifier", $next_state, { $call_identifier } }, |;
+        my $identifier;
+        # Set $identifier to NULL if there is no identifier
+        if ($token->{identifier} eq ""){
+            $identifier = "NULL"
+        }
+        else{
+            $identifier = qq|"$token->{identifier}"|;
+        }
+        say $tokfh qq|    { "$token_name", $identifier, $next_state, { $call_identifier } },|;
     }
     say $tokfh '};';
 }

i3-config-wizard/Makefile

@@ -1,10 +0,0 @@
-all:
-	$(MAKE) -C .. i3-config-wizard/i3-config-wizard
-
-install:
-	$(MAKE) -C .. install-i3-config-wizard
-
-clean:
-	$(MAKE) -C .. clean-i3-config-wizard
-
-.PHONY: all install clean

i3-config-wizard/atoms.xmacro

@@ -1,6 +0,0 @@
-xmacro(_NET_WM_NAME)
-xmacro(_NET_WM_WINDOW_TYPE)
-xmacro(_NET_WM_WINDOW_TYPE_DIALOG)
-xmacro(ATOM)
-xmacro(CARDINAL)
-xmacro(UTF8_STRING)

i3-config-wizard/i3-config-wizard-atoms.xmacro.h

@@ -0,0 +1,8 @@
+// clang-format off
+#define CONFIG_WIZARD_ATOMS_XMACRO		\
+xmacro(_NET_WM_NAME) \
+xmacro(_NET_WM_WINDOW_TYPE) \
+xmacro(_NET_WM_WINDOW_TYPE_DIALOG) \
+xmacro(ATOM) \
+xmacro(CARDINAL) \
+xmacro(UTF8_STRING)

i3-config-wizard/i3-config-wizard.mk

@@ -1,28 +0,0 @@
-ALL_TARGETS += i3-config-wizard/i3-config-wizard
-INSTALL_TARGETS += install-i3-config-wizard
-CLEAN_TARGETS += clean-i3-config-wizard
-
-i3_config_wizard_SOURCES           := $(wildcard i3-config-wizard/*.c)
-i3_config_wizard_HEADERS           := $(wildcard i3-config-wizard/*.h)
-i3_config_wizard_CFLAGS             = $(XCB_CFLAGS) $(XCB_KBD_CFLAGS) $(X11_CFLAGS) $(PANGO_CFLAGS)
-i3_config_wizard_LIBS               = $(XCB_LIBS) $(XCB_KBD_LIBS) $(X11_LIBS) $(PANGO_LIBS)
-
-i3_config_wizard_OBJECTS := $(i3_config_wizard_SOURCES:.c=.o)
-
-
-i3-config-wizard/%.o: i3-config-wizard/%.c $(i3_config_wizard_HEADERS) i3-config-parser.stamp
-	echo "[i3-config-wizard] CC $<"
-	$(CC) $(I3_CPPFLAGS) $(XCB_CPPFLAGS) $(CPPFLAGS) $(i3_config_wizard_CFLAGS) $(I3_CFLAGS) $(CFLAGS) -c -o $@ $<
-
-i3-config-wizard/i3-config-wizard: libi3.a $(i3_config_wizard_OBJECTS)
-	echo "[i3-config-wizard] Link i3-config-wizard"
-	$(CC) $(I3_LDFLAGS) $(LDFLAGS) -o $@ $(filter-out libi3.a,$^) $(LIBS) $(i3_config_wizard_LIBS)
-
-install-i3-config-wizard: i3-config-wizard/i3-config-wizard
-	echo "[i3-config-wizard] Install"
-	$(INSTALL) -d -m 0755 $(DESTDIR)$(PREFIX)/bin
-	$(INSTALL) -m 0755 i3-config-wizard/i3-config-wizard $(DESTDIR)$(PREFIX)/bin/
-
-clean-i3-config-wizard:
-	echo "[i3-config-wizard] Clean"
-	rm -f $(i3_config_wizard_OBJECTS) $(i3_config_wizard_SOURCES_GENERATED) i3-config-wizard/i3-config-wizard i3-config-wizard/cfgparse.*

i3-config-wizard/xcb.h

@@ -1,11 +1,10 @@
-#ifndef I3_XCB_H
-#define I3_XCB_H
+#pragma once
 
 /* from X11/keysymdef.h */
-#define XCB_NUM_LOCK                    0xff7f
+#define XCB_NUM_LOCK 0xff7f
 
-#define xmacro(atom) xcb_atom_t A_ ## atom;
-#include "atoms.xmacro"
+#include "i3-config-wizard-atoms.xmacro.h"
+
+#define xmacro(atom) xcb_atom_t A_##atom;
+CONFIG_WIZARD_ATOMS_XMACRO
 #undef xmacro
-
-#endif

i3-dmenu-desktop

@@ -1,7 +1,7 @@
 #!/usr/bin/env perl
 # vim:ts=4:sw=4:expandtab
 #
-# © 2012-2013 Michael Stapelberg
+# © 2012 Michael Stapelberg
 #
 # No dependencies except for perl ≥ v5.10
 
@@ -13,6 +13,7 @@ use POSIX qw(locale_h);
 use File::Find;
 use File::Basename qw(basename);
 use File::Temp qw(tempfile);
+use List::Util 'first';
 use Getopt::Long;
 use Pod::Usage;
 use v5.10;
@@ -25,7 +26,11 @@ binmode STDERR, ':utf8';
 # reads in a whole file
 sub slurp {
     my ($filename) = @_;
-    open(my $fh, '<', $filename) or die "$!";
+    my $fh;
+    if (!open($fh, '<', $filename)) {
+        warn "Could not open $filename: $!";
+        return undef;
+    }
     local $/;
     my $result;
     eval {
@@ -41,11 +46,13 @@ sub slurp {
 
 my @entry_types;
 my $dmenu_cmd = 'dmenu -i';
+my $show_duplicates;
 my $result = GetOptions(
     'dmenu=s' => \$dmenu_cmd,
     'entry-type=s' => \@entry_types,
+    'show-duplicates' => \$show_duplicates,
     'version' => sub {
-        say "dmenu-desktop 1.5 © 2012-2013 Michael Stapelberg";
+        say "dmenu-desktop 1.5 © 2012 Michael Stapelberg";
         exit 0;
     },
     'help' => sub {
@@ -55,8 +62,12 @@ my $result = GetOptions(
 die "Could not parse command line options" unless $result;
 
 # Filter entry types and set default type(s) if none selected
-my @valid_types = ('name', 'command', 'filename');
-@entry_types = grep { $_ ~~ @valid_types } @entry_types;
+my $valid_types = {
+    name => 1,
+    command => 1,
+    filename => 1,
+};
+@entry_types = grep { exists($valid_types->{$_}) } @entry_types;
 @entry_types = ('name', 'command') unless @entry_types;
 
 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@@ -67,7 +78,7 @@ my @valid_types = ('name', 'command', 'filename');
 # For details on how the transformation of LC_MESSAGES to a list of keys that
 # should be looked up works, refer to “Localized values for keys” of the
 # “Desktop Entry Specification”:
-# http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s04.html
+# https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s04.html
 my $lc_messages = setlocale(LC_MESSAGES);
 
 # Ignore the encoding (e.g. .UTF-8)
@@ -95,7 +106,7 @@ push @suffixes, $lc_messages;
 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
 my %desktops;
-# See http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables
+# See https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables
 my $xdg_data_home = $ENV{XDG_DATA_HOME};
 $xdg_data_home = $ENV{HOME} . '/.local/share' if
     !defined($xdg_data_home) ||
@@ -115,6 +126,8 @@ for my $dir (split(':', $xdg_data_dirs)) {
 # Cleanup the paths, maybe some application does not cope with double slashes
 # (the field code %k is replaced with the .desktop file location).
 @searchdirs = map { s,//,/,g; $_ } @searchdirs;
+# Also remove any trailing slashes.
+@searchdirs = map { s,/*$,,g; $_ } @searchdirs;
 
 # To avoid errors by File::Find’s find(), only pass existing directories.
 @searchdirs = grep { -d $_ } @searchdirs;
@@ -125,8 +138,15 @@ find(
             return unless substr($_, -1 * length('.desktop')) eq '.desktop';
             my $relative = $File::Find::name;
 
-            # + 1 for the trailing /, which is missing in ::topdir.
-            substr($relative, 0, length($File::Find::topdir) + 1) = '';
+            # Find and then replace the directory in @searchdirs in which the
+            # current file is located. We used to do this with
+            # $File::Find::topdir but it is not supported when using the
+            # 'follow' or 'follow_fast' options.
+            # See #3973, #4031.
+            my $topdir = first { substr($relative, 0, length($_)) eq $_ } @searchdirs;
+
+            # + 1 for the trailing /, which is missing in $topdir.
+            substr($relative, 0, length($topdir) + 1) = '';
 
             # Don’t overwrite files with the same relative path, we search in
             # descending order of importance.
@@ -135,6 +155,9 @@ find(
             $desktops{$relative} = $File::Find::name;
         },
         no_chdir => 1,
+        follow_fast => 1,
+        # Ignore any duplicate files and directories and proceed normally:
+        follow_skip => 2,
     },
     @searchdirs
 );
@@ -184,7 +207,7 @@ for my $file (values %desktops) {
                  $key eq 'Terminal') {
             # Values of type boolean must either be string true or false,
             # see “Possible value types”:
-            # http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html
+            # https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html
             $apps{$base}->{$key} = ($value eq 'true');
         }
     }
@@ -235,7 +258,7 @@ for my $app (keys %apps) {
     }
 
     # Don’t offer apps which have NoDisplay == true or Hidden == true.
-    # See http://wiki.xfce.org/howto/customize-menu#hide_menu_entries
+    # See https://wiki.xfce.org/howto/customize-menu#hide_menu_entries
     # for the difference between NoDisplay and Hidden.
     next if (exists($apps{$app}->{NoDisplay}) && $apps{$app}->{NoDisplay}) ||
             (exists($apps{$app}->{Hidden}) && $apps{$app}->{Hidden});
@@ -257,7 +280,7 @@ for my $app (keys %apps) {
         }
     }
 
-    if ('name' ~~ @entry_types) {
+    if ((scalar grep { $_ eq 'name' } @entry_types) > 0) {
         if (exists($choices{$name})) {
             # There are two .desktop files which contain the same “Name” value.
             # I’m not sure if that is allowed to happen, but we disambiguate the
@@ -271,24 +294,50 @@ for my $app (keys %apps) {
         }
 
         $choices{$name} = $app;
+        next unless $show_duplicates;
     }
 
-    if ('command' ~~ @entry_types) {
-        my ($command) = split(' ', $apps{$app}->{Exec});
+    if ((scalar grep { $_ eq 'command' } @entry_types) > 0) {
+        my $command = $apps{$app}->{Exec};
+
+        # Handle escape sequences (should be done for all string values, but does
+        # matter here).
+        my %escapes = (
+            '\\s' => ' ',
+            '\\n' => '\n',
+            '\\t' => '\t',
+            '\\r' => '\r',
+            '\\\\' => '\\',
+        );
+        $command =~ s/(\\[sntr\\])/$escapes{$1}/go;
+
+        # Extract executable
+        if ($command =~ m/^\s*([^\s\"]+)(?:\s|$)/) {
+            # No quotes
+            $command = $1;
+        } elsif ($command =~ m/^\s*\"([^\"\\]*(?:\\.[^\"\\]*)*)\"(?:\s|$)/) {
+            # Quoted, remove quotes and fix escaped characters
+            $command = $1;
+            $command =~ s/\\([\"\`\$\\])/$1/g;
+        } else {
+            # Invalid quotes, fallback to whitespace
+            ($command) = split(' ', $command);
+        }
 
         # Don’t add “geany” if “Geany” is already present.
         my @keys = map { lc } keys %choices;
-        next if lc(basename($command)) ~~ @keys;
-
-        $choices{basename($command)} = $app;
+        if (!(scalar grep { $_ eq lc(basename($command)) } @keys) > 0) {
+            $choices{basename($command)} = $app;
+        }
+        next unless $show_duplicates;
     }
 
-    if ('filename' ~~ @entry_types) {
+    if ((scalar grep { $_ eq 'filename' } @entry_types) > 0) {
         my $filename = basename($app, '.desktop');
 
         # Don’t add “geany” if “Geany” is already present.
         my @keys = map { lc } keys %choices;
-        next if lc($filename) ~~ @keys;
+        next if (scalar grep { $_ eq lc($filename) } @keys) > 0;
 
         $choices{$filename} = $app;
     }
@@ -302,7 +351,7 @@ for my $app (keys %apps) {
 #   };
 
 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-# ┃ Run dmenu to ask the user for her choice                                  ┃
+# ┃ Run dmenu to ask the user for their choice                                ┃
 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
 # open2 will just make dmenu’s STDERR go to our own STDERR.
@@ -319,9 +368,14 @@ binmode $dmenu_in, ':utf8';
 binmode $dmenu_out, ':utf8';
 
 # Feed dmenu the possible choices.
+# Since the process might have already exited, we ignore SIGPIPE.
+$SIG{PIPE} = 'IGNORE';
+
 say $dmenu_in $_ for sort keys %choices;
 close($dmenu_in);
 
+$SIG{PIPE} = 'DEFAULT';
+
 waitpid($pid, 0);
 my $status = ($? >> 8);
 
@@ -366,7 +420,7 @@ my $exec = $app->{Exec};
 my $location = $app->{_Location};
 
 # Quote as described by “The Exec key”:
-# http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s06.html
+# https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s07.html
 sub quote {
     my ($str) = @_;
     $str =~ s/("|`|\$|\\)/\\$1/g;
@@ -376,6 +430,18 @@ sub quote {
 
 $choice = quote($choice);
 $location = quote($location);
+$name = quote($name);
+
+# https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s07.html:
+#
+# Note that the general escape rule for values of type string states that the
+# backslash character can be escaped as ("\\") as well and that this escape rule
+# is applied before the quoting rule. As such, to unambiguously represent a
+# literal backslash character in a quoted argument in a desktop entry file
+# requires the use of four successive backslash characters ("\\\\"). Likewise, a
+# literal dollar sign in a quoted argument in a desktop entry file is
+# unambiguously represented with ("\\$").
+$exec =~ s/\\\\/\\/g;
 
 # Remove deprecated field codes, as the spec dictates.
 $exec =~ s/%[dDnNvm]//g;
@@ -405,7 +471,7 @@ $exec =~ s/%k/$location/g;
 $exec =~ s/%%/%/g;
 
 if (exists($app->{Path}) && $app->{Path} ne '') {
-    $exec = 'cd ' . $app->{Path} . ' && ' . $exec;
+    $exec = 'cd ' . quote($app->{Path}) . ' && ' . $exec;
 }
 
 my $nosn = '';
@@ -433,8 +499,10 @@ EOT
     # starts with a double quote ("), everything is parsed as-is until the next
     # double quote which is NOT preceded by a backslash (\).
     #
-    # Therefore, we escape all double quotes (") by replacing them with \"
-    $exec =~ s/"/\\"/g;
+    # Therefore, we escape all double quotes (") by replacing them with \".
+    # To not change the meaning of any double quote, backslashes need to be
+    # escaped as well.
+    $exec =~ s/(["\\])/\\$1/g;
 
     if (exists($app->{StartupNotify}) && !$app->{StartupNotify}) {
         $nosn = '--no-startup-id';
@@ -452,7 +520,7 @@ system('i3-msg', $cmd) == 0 or die "Could not launch i3-msg: $?";
 
 =head1 SYNOPSIS
 
-    i3-dmenu-desktop [--dmenu='dmenu -i'] [--entry-type=name]
+    i3-dmenu-desktop [--dmenu='dmenu -i'] [--entry-type=name] [--show-duplicates]
 
 =head1 DESCRIPTION
 
@@ -503,11 +571,15 @@ version of dmenu.
 
 Display the (localized) "Name" (type = name), the command (type = command) or
 the (*.desktop) filename (type = filename) in dmenu. This option can be
-specified multiple times.
+specified multiple times. Duplicates will be removed, see '--show-duplicates'.
 
 Examples are "GNU Image Manipulation Program" (type = name), "gimp" (type =
 command), and "libreoffice-writer" (type = filename).
 
+=item B<--show-duplicates>
+
+Show duplicates if '--entry-type' is specified multiple times.
+
 =back
 
 =head1 VERSION

i3-dump-log/Makefile

@@ -1,10 +0,0 @@
-all:
-	$(MAKE) -C .. i3-dump-log/i3-dump-log
-
-install:
-	$(MAKE) -C .. install-i3-dump-log
-
-clean:
-	$(MAKE) -C .. clean-i3-dump-log
-
-.PHONY: all install clean

i3-dump-log/i3-dump-log.mk

@@ -1,28 +0,0 @@
-ALL_TARGETS += i3-dump-log/i3-dump-log
-INSTALL_TARGETS += install-i3-dump-log
-CLEAN_TARGETS += clean-i3-dump-log
-
-i3_dump_log_SOURCES := $(wildcard i3-dump-log/*.c)
-i3_dump_log_HEADERS := $(wildcard i3-dump-log/*.h)
-i3_dump_log_CFLAGS   = $(XCB_CFLAGS) $(PANGO_CFLAGS)
-i3_dump_log_LIBS     = $(XCB_LIBS)
-
-i3_dump_log_OBJECTS := $(i3_dump_log_SOURCES:.c=.o)
-
-
-i3-dump-log/%.o: i3-dump-log/%.c $(i3_dump_log_HEADERS)
-	echo "[i3-dump-log] CC $<"
-	$(CC) $(I3_CPPFLAGS) $(XCB_CPPFLAGS) $(CPPFLAGS) $(i3_dump_log_CFLAGS) $(I3_CFLAGS) $(CFLAGS) -c -o $@ $<
-
-i3-dump-log/i3-dump-log: libi3.a $(i3_dump_log_OBJECTS)
-	echo "[i3-dump-log] Link i3-dump-log"
-	$(CC) $(I3_LDFLAGS) $(LDFLAGS) -o $@ $(filter-out libi3.a,$^) $(LIBS) $(i3_dump_log_LIBS)
-
-install-i3-dump-log: i3-dump-log/i3-dump-log
-	echo "[i3-dump-log] Install"
-	$(INSTALL) -d -m 0755 $(DESTDIR)$(PREFIX)/bin
-	$(INSTALL) -m 0755 i3-dump-log/i3-dump-log $(DESTDIR)$(PREFIX)/bin/
-
-clean-i3-dump-log:
-	echo "[i3-dump-log] Clean"
-	rm -f $(i3_dump_log_OBJECTS) i3-dump-log/i3-dump-log

i3-dump-log/main.c

@@ -1,50 +1,68 @@
 /*
  * vim:ts=4:sw=4:expandtab
  *
- * i3 - an improved dynamic tiling window manager
- * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
+ * i3 - an improved tiling window manager
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
  * i3-dump-log/main.c: Dumps the i3 SHM log to stdout.
  *
  */
-#include <stdio.h>
-#include <stdbool.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <sys/un.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <string.h>
-#include <errno.h>
-#include <err.h>
-#include <stdint.h>
-#include <getopt.h>
-#include <limits.h>
-#include <fcntl.h>
-#include <sys/mman.h>
-#include <sys/stat.h>
+#include <config.h>
 
 #include "libi3.h"
 #include "shmlog.h"
-#include <i3/ipc.h>
 
-static uint32_t offset_next_write,
-                wrap_count;
+#include <err.h>
+#include <fcntl.h>
+#include <getopt.h>
+#include <i3/ipc.h>
+#include <signal.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+
+static uint32_t wrap_count;
 
 static i3_shmlog_header *header;
 static char *logbuffer,
-            *walk;
+    *walk;
+static int ipcfd = -1;
+
+static void disable_shmlog(void) {
+    const char *disablecmd = "debuglog off; shmlog off";
+    if (ipc_send_message(ipcfd, strlen(disablecmd),
+                         I3_IPC_MESSAGE_TYPE_COMMAND, (uint8_t *)disablecmd) != 0) {
+        err(EXIT_FAILURE, "IPC send");
+    }
+
+    /* Ensure the command was sent by waiting for the reply: */
+    uint32_t reply_length = 0;
+    uint8_t *reply = NULL;
+    if (ipc_recv_message(ipcfd, I3_IPC_REPLY_TYPE_COMMAND,
+                         &reply_length, &reply) != 0) {
+        err(EXIT_FAILURE, "IPC recv");
+    }
+    free(reply);
+}
 
 static int check_for_wrap(void) {
-    if (wrap_count == header->wrap_count)
+    if (wrap_count == header->wrap_count) {
         return 0;
+    }
 
     /* The log wrapped. Print the remaining content and reset walk to the top
      * of the log. */
     wrap_count = header->wrap_count;
     const int len = (logbuffer + header->offset_last_wrap) - walk;
-    if (write(STDOUT_FILENO, walk, len) != len)
-        err(EXIT_FAILURE, "write()");
+    swrite(STDOUT_FILENO, walk, len);
     walk = logbuffer + sizeof(i3_shmlog_header);
     return 1;
 }
@@ -52,28 +70,40 @@ static int check_for_wrap(void) {
 static void print_till_end(void) {
     check_for_wrap();
     const int len = (logbuffer + header->offset_next_write) - walk;
-    const int n = write(STDOUT_FILENO, walk, len);
-    if (len != n)
-        err(EXIT_FAILURE, "write()");
-    if (n > 0) {
-        walk += n;
-    }
+    swrite(STDOUT_FILENO, walk, len);
+    walk += len;
+}
+
+void errorlog(char *fmt, ...) {
+    va_list args;
+
+    va_start(args, fmt);
+    vfprintf(stderr, fmt, args);
+    va_end(args);
 }
 
 int main(int argc, char *argv[]) {
     int o, option_index = 0;
-    bool verbose = false,
-         follow = false;
+    bool verbose = false;
+#if !defined(__OpenBSD__)
+    bool follow = false;
+#endif
 
     static struct option long_options[] = {
         {"version", no_argument, 0, 'v'},
         {"verbose", no_argument, 0, 'V'},
+#if !defined(__OpenBSD__)
         {"follow", no_argument, 0, 'f'},
+#endif
         {"help", no_argument, 0, 'h'},
         {0, 0, 0, 0}
     };
 
+#if !defined(__OpenBSD__)
     char *options_string = "s:vfVh";
+#else
+    char *options_string = "vVh";
+#endif
 
     while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
         if (o == 'v') {
@@ -81,16 +111,22 @@ int main(int argc, char *argv[]) {
             return 0;
         } else if (o == 'V') {
             verbose = true;
+#if !defined(__OpenBSD__)
         } else if (o == 'f') {
             follow = true;
+#endif
         } else if (o == 'h') {
             printf("i3-dump-log " I3_VERSION "\n");
-            printf("i3-dump-log [-f] [-s <socket>]\n");
+#if !defined(__OpenBSD__)
+            printf("i3-dump-log [-fhVv]\n");
+#else
+            printf("i3-dump-log [-hVv]\n");
+#endif
             return 0;
         }
     }
 
-    char *shmname = root_atom_contents("I3_SHMLOG_PATH");
+    char *shmname = root_atom_contents("I3_SHMLOG_PATH", NULL, 0);
     if (shmname == NULL) {
         /* Something failed. Let’s invest a little effort to find out what it
          * is. This is hugely helpful for users who want to debug i3 but are
@@ -109,41 +145,67 @@ int main(int argc, char *argv[]) {
             fprintf(stderr, "FYI: The DISPLAY environment variable is set to \"%s\".\n", getenv("DISPLAY"));
             exit(1);
         }
-        if (root_atom_contents("I3_CONFIG_PATH") != NULL) {
-            fprintf(stderr, "i3-dump-log: ERROR: i3 is running, but SHM logging is not enabled.\n\n");
-            if (!is_debug_build()) {
+        if (root_atom_contents("I3_CONFIG_PATH", conn, screen) != NULL) {
+            fprintf(stderr, "i3-dump-log: i3 is running, but SHM logging is not enabled. Enabling SHM log now while i3-dump-log is running\n\n");
+            ipcfd = ipc_connect(NULL);
+            const char *enablecmd = "debuglog on; shmlog 5242880";
+            if (ipc_send_message(ipcfd, strlen(enablecmd),
+                                 I3_IPC_MESSAGE_TYPE_COMMAND, (uint8_t *)enablecmd) != 0) {
+                err(EXIT_FAILURE, "IPC send");
+            }
+            /* By the time we receive a reply, I3_SHMLOG_PATH is set: */
+            uint32_t reply_length = 0;
+            uint8_t *reply = NULL;
+            if (ipc_recv_message(ipcfd, I3_IPC_REPLY_TYPE_COMMAND,
+                                 &reply_length, &reply) != 0) {
+                err(EXIT_FAILURE, "IPC recv");
+            }
+            free(reply);
+
+            atexit(disable_shmlog);
+
+            /* Retry: */
+            shmname = root_atom_contents("I3_SHMLOG_PATH", NULL, 0);
+            if (shmname == NULL && !is_debug_build()) {
                 fprintf(stderr, "You seem to be using a release version of i3:\n  %s\n\n", I3_VERSION);
                 fprintf(stderr, "Release versions do not use SHM logging by default,\ntherefore i3-dump-log does not work.\n\n");
-                fprintf(stderr, "Please follow this guide instead:\nhttp://i3wm.org/docs/debugging-release-version.html\n");
+                fprintf(stderr, "Please follow this guide instead:\nhttps://i3wm.org/docs/debugging-release-version.html\n");
                 exit(1);
             }
         }
-        errx(EXIT_FAILURE, "Cannot get I3_SHMLOG_PATH atom contents. Is i3 running on this display?");
+        if (shmname == NULL) {
+            errx(EXIT_FAILURE, "Cannot get I3_SHMLOG_PATH atom contents. Is i3 running on this display?");
+        }
     }
 
-    if (*shmname == '\0')
+    if (*shmname == '\0') {
         errx(EXIT_FAILURE, "Cannot dump log: SHM logging is disabled in i3.");
+    }
 
     struct stat statbuf;
 
     /* NB: While we must never write, we need O_RDWR for the pthread condvar. */
     int logbuffer_shm = shm_open(shmname, O_RDWR, 0);
-    if (logbuffer_shm == -1)
+    if (logbuffer_shm == -1) {
         err(EXIT_FAILURE, "Could not shm_open SHM segment for the i3 log (%s)", shmname);
+    }
 
-    if (fstat(logbuffer_shm, &statbuf) != 0)
+    if (fstat(logbuffer_shm, &statbuf) != 0) {
         err(EXIT_FAILURE, "stat(%s)", shmname);
+    }
 
-    /* NB: While we must never write, we need PROT_WRITE for the pthread condvar. */
-    logbuffer = mmap(NULL, statbuf.st_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0);
-    if (logbuffer == MAP_FAILED)
+    logbuffer = mmap(NULL, statbuf.st_size, PROT_READ, MAP_SHARED, logbuffer_shm, 0);
+    if (logbuffer == MAP_FAILED) {
         err(EXIT_FAILURE, "Could not mmap SHM segment for the i3 log");
+    }
 
-    header = (i3_shmlog_header*)logbuffer;
+    header = (i3_shmlog_header *)logbuffer;
 
-    if (verbose)
+    if (verbose) {
         printf("next_write = %d, last_wrap = %d, logbuffer_size = %d, shmname = %s\n",
                header->offset_next_write, header->offset_last_wrap, header->size, shmname);
+    }
+    free(shmname);
     walk = logbuffer + header->offset_next_write;
 
     /* We first need to print old content in case there was at least one
@@ -153,8 +215,9 @@ int main(int argc, char *argv[]) {
         /* In case there was a write to the buffer already, skip the first
          * old line, it very likely is mangled. Not a problem, though, the log
          * is chatty enough to have plenty lines left. */
-        while (*walk != '\n')
+        while (*walk != '\n') {
             walk++;
+        }
         walk++;
     }
 
@@ -167,21 +230,46 @@ int main(int argc, char *argv[]) {
     walk = logbuffer + sizeof(i3_shmlog_header);
     print_till_end();
 
-    if (follow) {
-        /* Since pthread_cond_wait() expects a mutex, we need to provide one.
-         * To not lock i3 (that’s bad, mhkay?) we just define one outside of
-         * the shared memory. */
-        pthread_mutex_t dummy_mutex = PTHREAD_MUTEX_INITIALIZER;
-        pthread_mutex_lock(&dummy_mutex);
-        while (1) {
-            pthread_cond_wait(&(header->condvar), &dummy_mutex);
-            /* If this was not a spurious wakeup, print the new lines. */
-            if (header->offset_next_write != offset_next_write) {
-                offset_next_write = header->offset_next_write;
-                print_till_end();
-            }
-        }
+#if !defined(__OpenBSD__)
+    if (!follow) {
+        return 0;
     }
 
+    char *log_stream_socket_path = root_atom_contents("I3_LOG_STREAM_SOCKET_PATH", NULL, 0);
+    if (log_stream_socket_path == NULL) {
+        errx(EXIT_FAILURE, "could not determine i3 log stream socket path: possible i3-dump-log and i3 version mismatch");
+    }
+
+    int sockfd = socket(AF_LOCAL, SOCK_STREAM, 0);
+    if (sockfd == -1) {
+        err(EXIT_FAILURE, "Could not create socket");
+    }
+
+    (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
+
+    struct sockaddr_un addr;
+    memset(&addr, 0, sizeof(struct sockaddr_un));
+    addr.sun_family = AF_LOCAL;
+    strncpy(addr.sun_path, log_stream_socket_path, sizeof(addr.sun_path) - 1);
+    if (connect(sockfd, (const struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
+        err(EXIT_FAILURE, "Could not connect to i3 on socket %s", log_stream_socket_path);
+    }
+
+    /* Same size as the buffer used in log.c vlog(): */
+    char buf[4096];
+    for (;;) {
+        const int n = read(sockfd, buf, sizeof(buf));
+        if (n == -1) {
+            err(EXIT_FAILURE, "read(log-stream-socket):");
+        }
+        if (n == 0) {
+            exit(0); /* i3 closed the socket */
+        }
+        buf[n] = '\0';
+        swrite(STDOUT_FILENO, buf, n);
+    }
+
+#endif
+    exit(0);
     return 0;
 }

i3-input/Makefile

@@ -1,10 +0,0 @@
-all:
-	$(MAKE) -C .. i3-input/i3-input
-
-install:
-	$(MAKE) -C .. install-i3-input
-
-clean:
-	$(MAKE) -C .. clean-i3-input
-
-.PHONY: all install clean

i3-input/i3-input.h

@@ -1,17 +1,14 @@
-#ifndef I3_INPUT
-#define I3_INPUT
+#pragma once
+
+#include <config.h>
 
 #include <err.h>
 
 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
-#define FREE(pointer) do { \
-        if (pointer != NULL) { \
-                free(pointer); \
-                pointer = NULL; \
-        } \
-} \
-while (0)
+#define FREE(pointer)   \
+    do {                \
+        free(pointer);  \
+        pointer = NULL; \
+    } while (0)
 
 extern xcb_window_t root;
-
-#endif

i3-input/i3-input.mk

@@ -1,28 +0,0 @@
-ALL_TARGETS += i3-input/i3-input
-INSTALL_TARGETS += install-i3-input
-CLEAN_TARGETS += clean-i3-input
-
-i3_input_SOURCES := $(wildcard i3-input/*.c)
-i3_input_HEADERS := $(wildcard i3-input/*.h)
-i3_input_CFLAGS   = $(XCB_CFLAGS) $(XCB_KBD_CFLAGS) $(PANGO_CFLAGS)
-i3_input_LIBS     = $(XCB_LIBS) $(XCB_KBD_LIBS) $(PANGO_LIBS)
-
-i3_input_OBJECTS := $(i3_input_SOURCES:.c=.o)
-
-
-i3-input/%.o: i3-input/%.c $(i3_input_HEADERS)
-	echo "[i3-input] CC $<"
-	$(CC) $(I3_CPPFLAGS) $(XCB_CPPFLAGS) $(CPPFLAGS) $(i3_input_CFLAGS) $(I3_CFLAGS) $(CFLAGS) -c -o $@ $<
-
-i3-input/i3-input: libi3.a $(i3_input_OBJECTS)
-	echo "[i3-input] Link i3-input"
-	$(CC) $(I3_LDFLAGS) $(LDFLAGS) -o $@ $(filter-out libi3.a,$^) $(LIBS) $(i3_input_LIBS)
-
-install-i3-input: i3-input/i3-input
-	echo "[i3-input] Install"
-	$(INSTALL) -d -m 0755 $(DESTDIR)$(PREFIX)/bin
-	$(INSTALL) -m 0755 i3-input/i3-input $(DESTDIR)$(PREFIX)/bin/
-
-clean-i3-input:
-	echo "[i3-input] Clean"
-	rm -f $(i3_input_OBJECTS) i3-input/i3-input