Merge pull request #1309 from yshui/inspect-monitor

Improvement of `picom-inspect`
yshui · Aug 9, 2024 · 2b3745b · 2b3745b
2 parents 9918c89 + 668ca01
commit 2b3745b
Show file tree

Hide file tree

Showing 14 changed files with 673 additions and 663 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@
 * Universal window rules (#1284). One option to rule them all! Added new configuration option `rules` to replace all existing rule options, and to provide more flexibility on top of that. See [picom(1)](https://picom.app/#_window_rules) for more details.
 * `@include` directives in config file now also search in `$XDG_CONFIG_HOME/picom/include` and `$XDG_CONFIG_DIRS/picom/include`, in addition to relative to the config file's parent directory.
 * Allow `corner-radius-rules` to override `corner-radius = 0`. Previously setting corner radius to 0 globally disables rounded corners. (#1170)
-* New `picom-inspect` tool, which lets you test out your picom rules. Sample output:
+* New `picom-inspect` tool, which lets you test out your picom rules. `man picom-inspect(1)` for more details. Sample output:
 
   ```
   ...

diff --git a/man/picom-inspect.1.adoc b/man/picom-inspect.1.adoc
@@ -19,12 +19,16 @@ DESCRIPTION
 
 OPTIONS
 -------
-*picom-inspect* accept the exact same set of options as *picom*. Naturally, most of those options will not be relevant.
+*picom-inspect* accepts all options that *picom* does. Naturally, most of those options will not be relevant.
 
 These are some of the options you might find useful (See *picom*(1) for descriptions of what they do):
 
 *--config*, *--log-level*, *--log-file*, all the options related to rules.
 
+*picom-inspect* also accepts some extra options: :::
+
+  *--monitor*:: Keep *picom-inspect* running in a loop, and dump information every time something changed about a window.
+
 NOTES
 -----
 *picom-inspect* is prototype right now. If you find any bug, for example, if rules are matched differently compared to *picom*, please submit bug reports to: