commit 0415e0084e7fb7adc60e094cad86ae2a99326415
parent 8f55f8e835a88057068933fe3fe638203b98c4b6
Author: elbachir-one <bachiralfa@gmail.com>
Date: Fri, 3 Jan 2025 16:44:04 +0100
[dwm][patches][betterswallow] Fixed index.md
Diffstat:
1 file changed, 42 insertions(+), 43 deletions(-)
diff --git a/dwm.suckless.org/patches/betterswallow/index.md b/dwm.suckless.org/patches/betterswallow/index.md
@@ -1,56 +1,55 @@
-# betterswallow
-
-## Description
-
-This patch adds "window swallowing" to dwm, as a few existing patches already do,
-but with another take on dynamic swallowing. In contrast to the existing
-[dynamicswallow](https://dwm.suckless.org/patches/dynamicswallow/) patch,
+betterswallow
+=============
+
+Description
+-----------
+This patch adds "window swallowing" to DWM, similar to some existing patches,
+but with a unique take on dynamic swallowing.
+Unlike the existing [dynamicswallow](https://dwm.suckless.org/patches/dynamicswallow/) patch,
`betterswallow` uses PID-based swallowing and a non-standard X11 ClientMessage
-for communication. As with `dynamicswallow`, an external tool `better-swallow`
-is required to use it. `better-swallow` is a separate tool that does not
-*require* this patch but is only enhanced by its presence, without the patch
-it falls back to the devour mechanism of unmapping the parent window itself.
-
-Development of this patch should only happen on the
-[GitHub repository](https://github.com/afishhh/better-swallow) of
-`better-swallow`, if you find any bugs feel free to open an issue.
-
-Currently only a version for dwm-6.3 exists, if you wish to update the patch to
-a newer version of DWM you can open a pull request to the `better-swallow`
-repository.
+for communication.
-## Download
+As with `dynamicswallow`, an external tool, `betterswallow`, is required
+to use this feature. `betterswallow` is a separate tool that does not require
+this patch but is enhanced by its presence. Without the patch, `betterswallow`
+defaults to the devour mechanism, which unmaps the parent window itself.
-- [dwm-betterswallow-20241215-89eeca1.diff](dwm-betterswallow-20241215-89eeca1.diff)
-- [better-swallow](https://github.com/afishhh/better-swallow)
+Development of this patch should happen on the [GitHub repository](https://github.com/afishhh/better-swallow)
+of `betterswallow`. If you encounter any bugs, feel free to open an issue.
-## Patching
+Currently, only a version for DWM-6.3 exists. If you wish to update the patch to
+a newer version of DWM, you can open a pull request on the `betterswallow` repository.
-The patch requires the `Xres` library, make sure you have it in your build environment.
-
-Unlike `dynamicswallow` you don't have to worry about any IPC patches, because
-this patch uses the simpler method of a ClientMessage for registering swallowers.
+#### Patching
+The patch requires the `Xres` library. Ensure it's included in your build environment.
+Unlike `dynamicswallow`, you don’t need to worry about any IPC patches, as this
+patch uses a simpler ClientMessage for registering swallowers.
If you have any patches that store geometry parameters in the `Client` struct,
-make sure they're copied in the `copyclientpos` function.
-
-## Usage
+ensure they are copied in the `copyclientpos` function.
-Run any graphical program you want to be swallowed as
-`better-swallow <CMD>`, this will cause any windows it spawns to replace the
-parent window.
+#### Usage
-Since `better-swallow` is a pretty long name I recommend creating an alias such as
-`bs`.
+To have any graphical program swallowed, run it as:
+```bash
+better-swallow <CMD>
+```
+This will cause any windows spawned by the command to replace the parent window.
+Since `betterswallow` is quite long, I recommend creating an alias, such as `bs`.
-## Limitations
+#### Limitations
-- Due to the reliance on the `Xres` extension and PIDs, this will fail if the X server
-is not running on the same machine as `better-swallow` and possibly add nonsensical
+- Due to reliance on the `Xres` extension and PIDs, this will fail if the X server
+is not running on the same machine as `betterswallow`, and it may add nonsensical
entries to the "swallow queue".
-- If a swallowed process opens the window deeper in the process tree it will not get
-swallowed. This may be fixed in the future by traversing the whole process chain
-instead of just one step up. Open an issue if you actually encounter this.
+- If a swallowed process opens a window deeper in the process tree, it will not
+be swallowed. This may be fixed in the future by traversing the entire process
+chain rather than just one step up. Open an issue if you encounter this.
+
+Download
+--------
+* [dwm-betterswallow-20241215-89eeca1.diff](dwm-betterswallow-20241215-89eeca1.diff) (2024-12-15)
-## Author
-- Hubert Głuchowski (<fishhh@fishhh.dev>)
+Author
+------
+* Hubert Głuchowski - <fishhh@fishhh.dev>
