Skip to content

Commit

Permalink
man: add manpage for picom-inspect
Browse files Browse the repository at this point in the history
Signed-off-by: Yuxuan Shui <[email protected]>
  • Loading branch information
yshui committed Feb 20, 2024
1 parent 0eba52e commit dc101e0
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 2 deletions.
2 changes: 1 addition & 1 deletion man/meson.build
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mans = ['picom.1', 'picom-trans.1']
mans = ['picom.1', 'picom-inspect.1', 'picom-trans.1']
if get_option('with_docs')
a2x = find_program('a2x')
foreach m : mans
Expand Down
40 changes: 40 additions & 0 deletions man/picom-inspect.1.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
picom-inspect(1)
================
:doctype: manpage
:man source: picom-inspect
:man version: {picom-version}
:man manual: User Commands

NAME
----
picom-inspect - easily test your picom rules

SYNOPSIS
--------
*picom-inspect* ['OPTIONS']

DESCRIPTION
-----------
*picom-inspect* matches your picom rules against a window of your choosing. It helps you test your rules, and shows you which ones of your rules (don't) work.

OPTIONS
-------
*picom-inspect* accept the exact same set of options as *picom*. 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.

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:

<https://github.com/yshui/picom>

RESOURCES
---------
Homepage: <https://github.com/yshui/picom>

SEE ALSO
--------
*xcompmgr*(1), link:picom.html[*picom*(1)]
2 changes: 1 addition & 1 deletion man/picom.1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -556,4 +556,4 @@ Homepage: <https://github.com/yshui/picom>
SEE ALSO
--------
*xcompmgr*(1), link:picom-trans.html[*picom-trans*(1)]
*xcompmgr*(1), link:picom-inspect.html[*picom-inspect*(1)], link:picom-trans.html[*picom-trans*(1)]

0 comments on commit dc101e0

Please sign in to comment.