Fixes for window fade-outs
[dana/xcompmgr.git] / xcompmgr.1
1 .ds q \N'34'
2 .TH xcompmgr 1
3 .SH NAME
4 xcompmgr \- sample X compositing manager
5 .SH SYNOPSIS
6 .nf
7 .B xcompmgr [\-d display] [\-r radius] [\-o opacity] [\-l left-offset] [\-t top-offset] [\-acCfFnsS]
8 .fi
9 .SH DESCRIPTION
10 .B xcompmgr
11 is a sample compositing manager for X servers supporting the XFIXES, DAMAGE,
12 and COMPOSITE extensions.  It enables basic eye-candy effects.
13 .SH OPTIONS
14 .TP
15 .BI \-d\ display
16 Specifies the display to manage.
17 .TP
18 .BI \-r\ radius
19 Specifies the blur radius for client-side shadows.
20 .TP
21 .BI \-o\ opacity
22 Specifies the opacity for client-side shadows.
23 .TP
24 .BI \-l\ left-offset
25 Specifies the left offset for client-side shadows.
26 .TP
27 .BI \-t\ top-offset
28 Specifies the top offset for client-side shadows. 
29 .TP
30 .BI \-I\ fade-in-step
31 Specifies the opacity change between steps while fading in.
32 .TP
33 .BI \-O\ fade-out-step
34 Specifies the opacity change between steps while fading out.
35 .TP
36 .BI \-D\ fade-delta
37 Specifies the time (in milliseconds) between steps in a fade.
38 .TP
39 .BI \-a
40 Automatic server-side compositing.  This instructs the server to use the
41 standard composition rules.  Useful for debugging.
42 .TP
43 .BI \-c
44 Client-side compositing with soft shadows and translucency support.
45 .TP
46 .BI \-f
47 When \-c is specified, enables a smooth fade effect for transient windows like
48 menus, and for all windows on hide and restore events.
49 .TP
50 .BI \-n
51 Simple client-side compositing.
52 .TP
53 .BI \-s
54 Server-side compositing with hard-edged shadows.
55 .TP
56 .BI \-C
57 When \-c is specified, attempts to avoid painting shadows on panels and docks.
58 .TP
59 .BI \-F
60 When \-f is specified, also enables the fade effect when windows change their
61 opacity, as with transset(1).
62 .TP
63 .BI \-S
64 Enables synchronous operation.  Useful for debugging.
65 .SH BUGS
66 Probably.  Please report any you find to http://bugs.freedesktop.org/.
67 .SH AUTHORS
68 Keith Packard, with contributions from Matthew Allum, Eric Anholt, Dan Doel,
69 Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth.