From 75aec17a85edc37f2e26f4a9fde48c8e30747631 Mon Sep 17 00:00:00 2001 From: Richard Grenville Date: Tue, 18 Dec 2012 22:04:22 +0800 Subject: [PATCH] Misc: Documentation update Update man page and README. --- README.md | 2 ++ man/compton.1.asciidoc | 21 +++++++++++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52637409..5d771349 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,8 @@ $ make install * There are two sets of man pages in the repository: the man pages in groff format (`man/compton.1` & `man/compton-trans.1`) and the man pages in Asciidoc format (`man/compton.1.asciidoc` & `man/compton-trans.1.asciidoc`). The Asciidoc man pages are much more up-to-date than the groff ones, and it is viewable online. As chjj has not yet expressed his attitude towards switching to Asciidoc man pages, I kept both versions. By default the groff version is installed, unless you run `make docs`. +* The performance of blurring is terrible, probably because of a problem in the X Render implementation. Its behavior is driver-dependent: With nvidia-drivers it works but there are strange 1px lines remaining when you operate on windows (not sure if it's a bug in compton or in the driver); with nouveau it's utterly broken. + ## Usage Please refer to the Asciidoc man pages (`man/compton.1.asciidoc` & `man/compton-trans.1.asciidoc`) for more details and examples. diff --git a/man/compton.1.asciidoc b/man/compton.1.asciidoc index aebb13d2..b06632fb 100644 --- a/man/compton.1.asciidoc +++ b/man/compton.1.asciidoc @@ -137,7 +137,7 @@ OPTIONS Painting on X Composite overlay window instead of on root window. *--sw-opti*:: - Limit compton to repaint at most once every 1 / 'refresh_rate' second to boost performance. Experimental. + Limit compton to repaint at most once every 1 / 'refresh_rate' second to boost performance. Experimental. This should not be used with *--vsync* as *--vsync* essentially does *--sw-opti*'s job already, unless you wish to specify a lower refresh rate than the actual value. *--use-ewmh-active-win*:: Use EWMH '_NET_ACTIVE_WINDOW' to determine currently focused window, rather than listening to 'FocusIn'/'FocusOut' event. Might have more accuracy, provided that the WM supports it. Experimental. @@ -151,6 +151,23 @@ OPTIONS *--focus-exclude* 'CONDITION':: Specify a list of conditions of windows that should always be considered focused. +*--inactive-dim-fixed*:: + Use fixed inactive dim value, instead of adjusting according to window opacity. + +*--detect-transient*:: + Use 'WM_TRANSIENT_FOR' to group windows, and consider windows in the same group focused at the same time. + +*--detect-client-leader*:: + Use 'WM_CLIENT_LEADER' to group windows, and consider windows in the same group focused at the same time. 'WM_TRANSIENT_FOR' has higher priority if *--detect-transient* is enabled, too. + +*--blur-background*:: + Blur background of semi-transparent / ARGB windows. Bad in performance, with driver-dependent behavior. The name of the switch may change without prior notifications. + +*--blur-background-frame*:: + Blur background of windows when the window frame is not opaque. Implies *--blur-background*. Bad in performance, with driver-dependent behavior. The name may change. + +*--blur-background-fixed*:: + Use fixed blur strength rather than adjusting according to window opacity. FORMAT OF CONDITIONS -------------------- @@ -159,7 +176,7 @@ FORMAT OF CONDITIONS condition = TARGET:TYPE[FLAGS]:PATTERN -'TARGET' is one of "n" (window name), "i" (window class instance), and "g" (window general class) +'TARGET' is one of "n" (window name), "i" (window class instance), "g" (window general class), and "r" (window role). 'TYPE' is one of "e" (exact match), "a" (match anywhere), "s" (match from start), "w" (wildcard), and "p" (PCRE regular expressions, if compiled with the support).