{"id":24375438,"url":"https://github.com/theegghead27/dwl-patches","last_synced_at":"2025-07-01T18:02:24.477Z","repository":{"id":273025412,"uuid":"918500104","full_name":"TheEgghead27/dwl-patches","owner":"TheEgghead27","description":"My personal build of DWL, inspired by my DWM configuration.","archived":false,"fork":false,"pushed_at":"2025-01-18T04:58:09.000Z","size":1230,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T12:24:33.327Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheEgghead27.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-18T04:54:31.000Z","updated_at":"2025-01-18T04:58:57.000Z","dependencies_parsed_at":"2025-01-18T05:29:26.136Z","dependency_job_id":"b48e116f-74c9-4190-a016-5d4401255338","html_url":"https://github.com/TheEgghead27/dwl-patches","commit_stats":null,"previous_names":["theegghead27/dwl-patches"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TheEgghead27/dwl-patches","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheEgghead27%2Fdwl-patches","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheEgghead27%2Fdwl-patches/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheEgghead27%2Fdwl-patches/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheEgghead27%2Fdwl-patches/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheEgghead27","download_url":"https://codeload.github.com/TheEgghead27/dwl-patches/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheEgghead27%2Fdwl-patches/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263013701,"owners_count":23399812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-19T05:57:34.184Z","updated_at":"2025-07-01T18:02:24.398Z","avatar_url":"https://github.com/TheEgghead27.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dwl - dwm for Wayland\n\nJoin us on our IRC channel: [#dwl on Libera Chat]  \nOr on our [Discord server].\n\ndwl is a compact, hackable compositor for [Wayland] based on [wlroots]. It is\nintended to fill the same space in the Wayland world that dwm does in X11,\nprimarily in terms of functionality, and secondarily in terms of\nphilosophy. Like dwm, dwl is:\n\n- Easy to understand, hack on, and extend with patches\n- One C source file (or a very small number) configurable via `config.h`\n- Tied to as few external dependencies as possible\n\n## Getting Started:\n\n### **dwl branch 0.7 and releases based upon 0.7 build against [wlroots] 0.18**\n\n### Latest semi-stable [release]\nThis is probably where you want to start. This builds against the dependent\npackages' versions currently shipping in major distributions. If your\ndistribution's wlroots version is older, use an earlier dwl [release] or [0.x\nbranch].\n\n### Development branch [main]\nActive development progresses on the `main` branch. The `main` branch is built\nagainst a late (and often changing) git commit of wlroots. While the adventurous\nare welcome to use `main`, it is a rocky road. Using `main` requires that the\nuser be willing to chase git commits of wlroots. Testing development pull\nrequests may involve merging unmerged pull requests in [wlroots]' git repository\nand/or git commits of wayland.\n  \n### Building dwl\ndwl has the following dependencies:\n- libinput\n- wayland\n- wlroots (compiled with the libinput backend)\n- xkbcommon\n- wayland-protocols (compile-time only)\n- pkg-config (compile-time only)\n\ndwl has the following additional dependencies if XWayland support is enabled:\n- libxcb\n- libxcb-wm\n- wlroots (compiled with X11 support)\n- Xwayland (runtime only)\n\nInstall these (and their `-devel` versions if your distro has separate\ndevelopment packages) and run `make`. If you wish to build against a released\nversion of wlroots (*you probably do*), use a [release] or a [0.x branch]. If\nyou want to use the unstable development `main` branch, you need to use the git\nversion of [wlroots].\n\nTo enable XWayland, you should uncomment its flags in `config.mk`.\n\n## Configuration\n\nAll configuration is done by editing `config.h` and recompiling, in the same\nmanner as dwm. There is no way to separately restart the window manager in\nWayland without restarting the entire display server, so any changes will take\neffect the next time dwl is executed.\n\nAs in the dwm community, we encourage users to share patches they have\ncreated. Check out the [dwl-patches] repository!\n\n## Running dwl\n\ndwl can be run on any of the backends supported by wlroots. This means you can\nrun it as a separate window inside either an X11 or Wayland session, as well as\ndirectly from a VT console. Depending on your distro's setup, you may need to\nadd your user to the `video` and `input` groups before you can run dwl on a\nVT. If you are using `elogind` or `systemd-logind` you need to install polkit;\notherwise you need to add yourself in the `seat` group and enable/start the\nseatd daemon.\n\nWhen dwl is run with no arguments, it will launch the server and begin handling\nany shortcuts configured in `config.h`. There is no status bar or other\ndecoration initially; these are instead clients that can be run within the\nWayland session. Do note that the default background color is black. This can be\nmodified in `config.h`.\n\nIf you would like to run a script or command automatically at startup, you can\nspecify the command using the `-s` option. This command will be executed as a\nshell command using `/bin/sh -c`.  It serves a similar function to `.xinitrc`,\nbut differs in that the display server will not shut down when this process\nterminates. Instead, dwl will send this process a SIGTERM at shutdown and wait\nfor it to terminate (if it hasn't already). This makes it ideal for execing into\na user service manager like [s6], [anopa], [runit], [dinit], or [`systemd\n--user`].\n\nNote: The `-s` command is run as a *child process* of dwl, which means that it\ndoes not have the ability to affect the environment of dwl or of any processes\nthat it spawns. If you need to set environment variables that affect the entire\ndwl session, these must be set prior to running dwl. For example, Wayland\nrequires a valid `XDG_RUNTIME_DIR`, which is usually set up by a session manager\nsuch as `elogind` or `systemd-logind`.  If your system doesn't do this\nautomatically, you will need to configure it prior to launching `dwl`, e.g.:\n\n    export XDG_RUNTIME_DIR=/tmp/xdg-runtime-$(id -u)\n    mkdir -p $XDG_RUNTIME_DIR\n    dwl\n\n### Status information\n\nInformation about selected layouts, current window title, app-id, and\nselected/occupied/urgent tags is written to the stdin of the `-s` command (see\nthe `printstatus()` function for details).  This information can be used to\npopulate an external status bar with a script that parses the\ninformation. Failing to read this information will cause dwl to block, so if you\ndo want to run a startup command that does not consume the status information,\nyou can close standard input with the `\u003c\u0026-` shell redirection, for example:\n\n    dwl -s 'foot --server \u003c\u0026-'\n\nIf your startup command is a shell script, you can achieve the same inside the\nscript with the line\n\n    exec \u003c\u0026-\n\nTo get a list of status bars that work with dwl consult our [wiki].\n\n## Replacements for X applications\n\nYou can find a [list of useful resources on our wiki].\n\n## Background\n\ndwl is not meant to provide every feature under the sun. Instead, like dwm, it\nsticks to features which are necessary, simple, and straightforward to implement\ngiven the base on which it is built. Implemented default features are:\n\n- Any features provided by dwm/Xlib: simple window borders, tags, keybindings,\n  client rules, mouse move/resize. Providing a built-in status bar is an\n  exception to this goal, to avoid dependencies on font rendering and/or drawing\n  libraries when an external bar could work well.\n- Configurable multi-monitor layout support, including position and rotation\n- Configurable HiDPI/multi-DPI support\n- Idle-inhibit protocol which lets applications such as mpv disable idle\n  monitoring\n- Provide information to external status bars via stdout/stdin\n- Urgency hints via xdg-activate protocol\n- Support screen lockers via ext-session-lock-v1 protocol\n- Various Wayland protocols\n- XWayland support as provided by wlroots (can be enabled in `config.mk`)\n- Zero flickering - Wayland users naturally expect that \"every frame is perfect\"\n- Layer shell popups (used by Waybar)\n- Damage tracking provided by scenegraph API\n\nGiven the Wayland architecture, dwl has to implement features from dwm **and**\nthe xorg-server. Because of this, it is impossible to maintain the original\nproject goal of 2000 SLOC and have a reasonably complete compositor with\nfeatures comparable to dwm. However, this does not mean that the code will grow\nindiscriminately. We will try to keep the code as small as possible.\n\nFeatures under consideration (possibly as patches) are:\n\n- Protocols made trivial by wlroots\n- Implement the text-input and input-method protocols to support IME once ibus\n  implements input-method v2 (see https://github.com/ibus/ibus/pull/2256 and\n  https://codeberg.org/dwl/dwl/pulls/235)\n\nFeature *non-goals* for the main codebase include:\n\n- Client-side decoration (any more than is necessary to tell the clients not to)\n- Client-initiated window management, such as move, resize, and close, which can\n  be done through the compositor\n- Animations and visual effects\n\n## Acknowledgements\n\ndwl began by extending the TinyWL example provided (CC0) by the sway/wlroots\ndevelopers. This was made possible in many cases by looking at how sway\naccomplished something, then trying to do the same in as suckless a way as\npossible.\n\nMany thanks to suckless.org and the dwm developers and community for the\ninspiration, and to the various contributors to the project, including:\n\n- **Devin J. Pohly for creating and nurturing the fledgling project**\n- Alexander Courtis for the XWayland implementation\n- Guido Cella for the layer-shell protocol implementation, patch maintenance,\n  and for helping to keep the project running\n- Stivvo for output management and fullscreen support, and patch maintenance\n\n\n[`systemd --user`]: https://wiki.archlinux.org/title/Systemd/User\n[#dwl on Libera Chat]: https://web.libera.chat/?channels=#dwl\n[0.7-rc1]: https://codeberg.org/dwl/dwl/releases/tag/v0.7-rc1\n[0.x branch]: https://codeberg.org/dwl/dwl/branches\n[anopa]: https://jjacky.com/anopa/\n[dinit]: https://davmac.org/projects/dinit/\n[dwl-patches]: https://codeberg.org/dwl/dwl-patches\n[list of useful resources on our wiki]: https://codeberg.org/dwl/dwl/wiki/Home#migrating-from-x\n[main]: https://codeberg.org/dwl/dwl/src/branch/main\n[release]: https://codeberg.org/dwl/dwl/releases\n[runit]: http://smarden.org/runit/faq.html#userservices\n[s6]: https://skarnet.org/software/s6/\n[wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots/\n[wiki]: https://codeberg.org/dwl/dwl/wiki/Home#compatible-status-bars\n[Discord server]: https://discord.gg/jJxZnrGPWN\n[Wayland]: https://wayland.freedesktop.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheegghead27%2Fdwl-patches","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheegghead27%2Fdwl-patches","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheegghead27%2Fdwl-patches/lists"}