Sivecano/dwl - Change 7KQIKBVNUPGXAH4SSH2AZTQHNG6BVW4JQZEYX4DHSZG7IAKFY2YQC

Documentation restructuring

Modified documentation to make clear the change in development (main) branch versus releases.

(cherry picked from commit ad30ca910b9da45835523af5c24ac353b7d13e9f)

Created by A Frederick Christensen on July 17, 2024

7KQIKBVNUPGXAH4SSH2AZTQHNG6BVW4JQZEYX4DHSZG7IAKFY2YQC

Dependencies

In channels

main

Change contents

Replacement in README.md at line 8 [11.36546]

B:BD[10.229] → [6.11:88]

∅:D[6.88] → [10.306:324]

B:BD[10.306] → [10.306:324]

primarily in terms of functionality, and secondarily in terms of philosophy.
Like dwm, dwl is:

[10.229]

[12.311]

primarily in terms of functionality, and secondarily in terms of
philosophy. Like dwm, dwl is:

Replacement in README.md at line 15 [11.36546]

B:BD[12.549] → [10.325:556]

dwl is not meant to provide every feature under the sun. Instead, like dwm, it
sticks to features which are necessary, simple, and straightforward to implement
given the base on which it is built. Implemented default features are:

[12.549]

[11.36553]

## Getting Started:

Replacement in README.md at line 17 [11.36546]

B:BD[11.36554] → [10.557:840]

∅:D[13.285] → [12.1165:1281]

∅:D[14.796] → [12.1165:1281]

∅:D[10.840] → [12.1165:1281]

∅:D[15.898] → [12.1165:1281]

B:BD[12.1165] → [12.1165:1281]

B:BD[12.1281] → [10.841:927]

∅:D[10.927] → [16.8:71]

∅:D[17.1279] → [16.8:71]

B:BD[12.1281] → [16.8:71]

B:BD[16.71] → [18.1141:1183]

B:BD[18.1183] → [3.11:69]

∅:D[3.69] → [14.797:825]

∅:D[16.71] → [14.797:825]

∅:D[19.429] → [14.797:825]

∅:D[18.1183] → [14.797:825]

B:BD[12.1281] → [14.797:825]

B:BD[14.825] → [16.72:146]

∅:D[16.146] → [20.3:84]

B:BD[21.45] → [20.3:84]

B:BD[20.84] → [22.8:91]

- Any features provided by dwm/Xlib: simple window borders, tags, keybindings,
  client rules, mouse move/resize. Providing a built-in status bar is an
  exception to this goal, to avoid dependencies on font rendering and/or
  drawing libraries when an external bar could work well.
- Configurable multi-monitor layout support, including position and rotation
- Configurable HiDPI/multi-DPI support
- Idle-inhibit protocol which lets applications such as mpv disable idle
  monitoring
- Provide information to external status bars via stdout/stdin
- Urgency hints via xdg-activate protocol
- Support screen lockers via ext-session-lock-v1 protocol
- Various Wayland protocols
- XWayland support as provided by wlroots (can be enabled in `config.mk`)
- Zero flickering - Wayland users naturally expect that "every frame is perfect"
- Layer shell popups (used by Waybar)
- Damage tracking provided by scenegraph API

[11.36554]

[11.36881]

### Latest semi-stable [release]
This is probably where you want to start. This builds against the dependent
packages' versions currently shipping in major distributions. If your
distribution's wlroots version is older, use an earlier dwl [release] or [0.x
branch].

Replacement in README.md at line 23 [11.36546]

B:BD[11.36882] → [23.11:90]

B:BD[23.90] → [7.11:309]

∅:D[7.309] → [23.267:268]

B:BD[23.267] → [23.267:268]

∅:D[23.268] → [24.8:64]

B:BD[11.36882] → [24.8:64]

∅:D[24.64] → [11.36882:36883]

∅:D[25.66] → [11.36882:36883]

∅:D[14.862] → [11.36882:36883]

∅:D[12.1633] → [11.36882:36883]

B:BD[11.36882] → [11.36882:36883]

B:BD[11.36883] → [24.65:101]

B:BD[24.101] → [10.928:1084]

B:BD[10.1084] → [26.11:53]

∅:D[26.53] → [27.3:4]

∅:D[28.206] → [27.3:4]

∅:D[10.1127] → [27.3:4]

∅:D[14.1845] → [27.3:4]

B:BD[12.1953] → [27.3:4]

B:BD[27.4] → [16.274:325]

∅:D[27.34] → [12.1953:1954]

∅:D[16.325] → [12.1953:1954]

B:BD[12.1953] → [12.1953:1954]

B:BD[12.1954] → [27.35:116]

B:BD[27.116] → [10.1128:1242]

∅:D[10.1242] → [16.326:358]

B:BD[27.228] → [16.326:358]

∅:D[16.358] → [27.229:230]

B:BD[12.1955] → [27.229:230]

∅:D[27.230] → [11.36883:36899]

∅:D[12.1955] → [11.36883:36899]

B:BD[11.36883] → [11.36883:36899]

Given the Wayland architecture, dwl has to implement features from dwm **and**
the xorg-server. Because of this, it is impossible to maintain the original
project goal of 2000 SLOC and have a reasonably complete compositor with
features comparable to dwm. However, this does not mean that the code will grow
indiscriminately. We will try to keep the code as small as possible.
Features under consideration (possibly as patches) are:
- Protocols made trivial by wlroots
- Implement the text-input and input-method protocols to support IME once ibus
  implements input-method v2 (see https://github.com/ibus/ibus/pull/2256 and
  https://codeberg.org/dwl/dwl/pulls/235)
Feature *non-goals* for the main codebase include:
- Client-side decoration (any more than is necessary to tell the clients not to)
- Client-initiated window management, such as move, resize, and close, which can
  be done through the compositor
- Animations and visual effects
## Building dwl

[11.36882]

[11.36899]

### Development branch [main]
Active development progresses on the `main` branch. The `main` branch is built
against a late (and often changing) git commit of wlroots. While the adventurous
are welcome to use `main`, it is a rocky road. Using `main` requires that the
user be willing to chase git commits of wlroots. Testing development pull
requests may involve merging unmerged pull requests in [wlroots]' git repository
and/or git commits of wayland.
  
### Building dwl
dwl has the following dependencies:
- libinput
- wayland
- wlroots (compiled with the libinput backend)
- xkbcommon
- wayland-protocols (compile-time only)
- pkg-config (compile-time only)

Replacement in README.md at line 40 [11.36546]

B:BD[11.36900] → [4.11:308]

dwl has the following dependencies:
```
libinput
wayland
wlroots (compiled with the libinput backend)
xkbcommon
wayland-protocols (compile-time only)
pkg-config (compile-time only)
```
If you enable X11 support:
```
libxcb
libxcb-wm
wlroots (compiled with X11 support)
Xwayland (runtime only)
```

[11.36900]

[29.79]

dwl has the following additional dependencies if XWayland support is enabled:
- libxcb
- libxcb-wm
- wlroots (compiled with X11 support)
- Xwayland (runtime only)

Replacement in README.md at line 46 [11.36546]

B:BD[29.80] → [10.1243:1321]

B:BD[10.1321] → [9.12:214]

Simply install these (and their `-devel` versions if your distro has separate
development packages) and run `make`. You need to use the Git version of
wlroots to build the `main` branch. If you wish to build against a released
version of wlroots, use a release or a [0.x branch].

[29.80]

[30.9]

Install these (and their `-devel` versions if your distro has separate
development packages) and run `make`. If you wish to build against a released
version of wlroots (*you probably do*), use a [release] or a [0.x branch]. If
you want to use the unstable development `main` branch, you need to use the git
version of [wlroots].

Replacement in README.md at line 61 [11.36546]

B:BD[31.9] → [10.1821:1901]

B:BD[10.1901] → [8.11:51]

As in the dwm community, we encourage users to share patches they have created.
Check out the dwl [patches repository]!

[31.9]

[11.37136]

As in the dwm community, we encourage users to share patches they have
created. Check out the [dwl-patches] repository!

Replacement in README.md at line 67 [11.36546]

B:BD[10.2023] → [10.2023:2426]

run it as a separate window inside either an X11 or Wayland session, as well
as directly from a VT console. Depending on your distro's setup, you may need
to add your user to the `video` and `input` groups before you can run dwl on
a VT. If you are using `elogind` or `systemd-logind` you need to install
polkit; otherwise you need to add yourself in the `seat` group and
enable/start the seatd daemon.

[10.2023]

[12.2347]

run it as a separate window inside either an X11 or Wayland session, as well as
directly from a VT console. Depending on your distro's setup, you may need to
add your user to the `video` and `input` groups before you can run dwl on a
VT. If you are using `elogind` or `systemd-logind` you need to install polkit;
otherwise you need to add yourself in the `seat` group and enable/start the
seatd daemon.

Replacement in README.md at line 76 [11.36546]

B:BD[10.2579] → [10.2579:2671]

B:BD[10.2671] → [3.70:114]

decoration initially; these are instead clients that can be run within
the Wayland session.
Do note that the background color is black.

[10.2579]

[11.37152]

decoration initially; these are instead clients that can be run within the
Wayland session. Do note that the default background color is black. This can be
modified in `config.h`.

Replacement in README.md at line 86 [11.36546]

B:BD[10.3144] → [5.11:95]

a user service manager like [s6], [anopa], [runit], [dinit], or [`systemd --user`].

[10.3144]

[32.197]

a user service manager like [s6], [anopa], [runit], [dinit], or [`systemd
--user`].

Replacement in README.md at line 106 [11.36546]

B:BD[10.3979] → [10.3979:4277]

populate an external status bar with a script that parses the information.
Failing to read this information will cause dwl to block, so if you do want to
run a startup command that does not consume the status information, you can
close standard input with the `<&-` shell redirection, for example:

[10.3979]

[33.1796]

populate an external status bar with a script that parses the
information. Failing to read this information will cause dwl to block, so if you
do want to run a startup command that does not consume the status information,
you can close standard input with the `<&-` shell redirection, for example:

Insertion in README.md at line 123 [11.36546]

[10.4503]

[11.37794]


## Background
dwl is not meant to provide every feature under the sun. Instead, like dwm, it
sticks to features which are necessary, simple, and straightforward to implement
given the base on which it is built. Implemented default features are:

Insertion in README.md at line 130 [11.36546]

[11.37795]

[12.3945]

- Any features provided by dwm/Xlib: simple window borders, tags, keybindings,
  client rules, mouse move/resize. Providing a built-in status bar is an
  exception to this goal, to avoid dependencies on font rendering and/or drawing
  libraries when an external bar could work well.
- Configurable multi-monitor layout support, including position and rotation
- Configurable HiDPI/multi-DPI support
- Idle-inhibit protocol which lets applications such as mpv disable idle
  monitoring
- Provide information to external status bars via stdout/stdin
- Urgency hints via xdg-activate protocol
- Support screen lockers via ext-session-lock-v1 protocol
- Various Wayland protocols
- XWayland support as provided by wlroots (can be enabled in `config.mk`)
- Zero flickering - Wayland users naturally expect that "every frame is perfect"
- Layer shell popups (used by Waybar)
- Damage tracking provided by scenegraph API
Given the Wayland architecture, dwl has to implement features from dwm **and**
the xorg-server. Because of this, it is impossible to maintain the original
project goal of 2000 SLOC and have a reasonably complete compositor with
features comparable to dwm. However, this does not mean that the code will grow
indiscriminately. We will try to keep the code as small as possible.
Features under consideration (possibly as patches) are:
- Protocols made trivial by wlroots
- Implement the text-input and input-method protocols to support IME once ibus
  implements input-method v2 (see https://github.com/ibus/ibus/pull/2256 and
  https://codeberg.org/dwl/dwl/pulls/235)
Feature *non-goals* for the main codebase include:
- Client-side decoration (any more than is necessary to tell the clients not to)
- Client-initiated window management, such as move, resize, and close, which can
  be done through the compositor
- Animations and visual effects

Replacement in README.md at line 184 [11.36546]

B:BD[10.5012] → [10.5012:5060]

B:BD[10.5060] → [2.91:153]

∅:D[2.153] → [10.5107:5210]

B:BD[10.5107] → [10.5107:5210]

B:BD[10.5210] → [9.215:267]

∅:D[9.267] → [34.48:107]

B:BD[26.130] → [34.48:107]

∅:D[35.129] → [10.5354:5393]

∅:D[26.200] → [10.5354:5393]

B:BD[10.5354] → [10.5354:5393]

[Discord server]: https://discord.gg/jJxZnrGPWN
[#dwl on Libera Chat]: https://web.libera.chat/?channels=#dwl
[Wayland]: https://wayland.freedesktop.org/
[wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots/
[0.x branch]: https://codeberg.org/dwl/dwl/branches
[patches repository]: https://codeberg.org/dwl/dwl-patches
[s6]: https://skarnet.org/software/s6/

[10.5012]

[10.5393]

[`systemd --user`]: https://wiki.archlinux.org/title/Systemd/User [#dwl on Libera Chat]: https://web.libera.chat/?channels=#dwl
[0.7-rc1]: https://codeberg.org/dwl/dwl/releases/tag/v0.7-rc1 [0.x branch]: https://codeberg.org/dwl/dwl/branches

Deletion in README.md at line 187 [11.36546]
B:BD[10.5428] → [10.5428:5484]
```
[runit]: http://smarden.org/runit/faq.html#userservices
```

Replacement in README.md at line 188 [11.36546]

∅:D[5.140] → [10.5484:5550]

B:BD[10.5484] → [10.5484:5550]

B:BD[10.5550] → [26.201:271]

∅:D[26.271] → [10.5617:5657]

B:BD[10.5617] → [10.5617:5657]

B:BD[10.5657] → [26.272:332]

[`systemd --user`]: https://wiki.archlinux.org/title/Systemd/User
[wiki]: https://codeberg.org/dwl/dwl/wiki/Home#compatible-status-bars
[list of useful resources on our wiki]:
    https://codeberg.org/dwl/dwl/wiki/Home#migrating-from-x

[5.140]

[dwl-patches]: https://codeberg.org/dwl/dwl-patches [list of useful resources on our wiki]: https://codeberg.org/dwl/dwl/wiki/Home#migrating-from-x
[main]: https://codeberg.org/dwl/dwl/src/branch/main
[release]: https://codeberg.org/dwl/dwl/releases
[runit]: http://smarden.org/runit/faq.html#userservices
[s6]: https://skarnet.org/software/s6/
[wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots/
[wiki]: https://codeberg.org/dwl/dwl/wiki/Home#compatible-status-bars [Discord server]: https://discord.gg/jJxZnrGPWN
[Wayland]: https://wayland.freedesktop.org/