From 2cb499de0bd5b16c17e933e4749a84f3647ebe1f Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Wed, 16 Nov 2011 00:04:38 -0600 Subject: [PATCH] add options to readme --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ce29a82..b7508b7 100644 --- a/README.md +++ b/README.md @@ -53,12 +53,49 @@ $ make install ## Usage ``` bash -$ compton -cC -t -5 -l -5 -r 5 -o 0.4 \ - -fF -I 0.065 -O 0.065 -D 6 -m 0.8 -i 0.6 -e 0.6 & - -$ compton -cC -t -5 -l -5 -r 5 -o 0.4 -i 0.6 -e 0.6 & +$ compton -cC -i 0.6 -e 0.6 +$ compton -cC -fF -I 0.065 -O 0.065 -D 6 -m 0.8 ``` +### Options + + compton [-d display] [-r radius] [-o opacity] + [-l left-offset] [-t top-offset] + [-i opacity] [-e opacity] [-cCfFS] + +* -d display + Specifies the display to manage. +* -r radius + Specifies the blur radius for client-side shadows. +* -o opacity + Specifies the opacity for client-side shadows. +* -l left-offset + Specifies the left offset for client-side shadows. +* -t top-offset + Specifies the top offset for client-side shadows. +* -I fade-in-step + Specifies the opacity change between steps while fading in. +* -O fade-out-step + Specifies the opacity change between steps while fading out. +* -D fade-delta + Specifies the time (in milliseconds) between steps in a fade. +* -c + Enable client-side shadows on windows. +* -f + When -c is specified, enables a smooth fade effect for transient windows like + menus, and for all windows on hide and restore events. +* -C + When -c is specified, attempts to avoid painting shadows on panels and docks. +* -F + When -f is specified, also enables the fade effect when windows change their + opacity, as with transset(1). +* -i opacity + Specifies inactive window transparency. (0.1 - 1.0) +* -e opacity + Specifies window frame transparency. (0.1 - 1.0) +* -S + Enables synchronous operation. Useful for debugging. + ## License xcompmgr has gotten around. As far as I can tell, the lineage for this