More effects, bug fixes, doc updates.
[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] [\-acfnsCFS]
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 \-a
19 Automatic server-side compositing.  This instructs the server to use the
20 standard composition rules.  Useful for debugging.
21 .TP
22 .BI \-c
23 Client-side compositing with soft shadows and translucency support.
24 .TP
25 .BI \-f
26 When \-c is specified, enables a smooth fade effect for transient windows like
27 menus, and for all windows on hide and restore events.
28 .TP
29 .BI \-n
30 Simple client-side compositing.
31 .TP
32 .BI \-s
33 Server-side compositing with hard-edged shadows.
34 .TP
35 .BI \-C
36 When \-c is specified, attempts to avoid painting shadows on panels and docks.
37 .TP
38 .BI \-F
39 When \-f is specified, also enables the fade effect when windows change their
40 opacity, as with transset(1).
41 .TP
42 .BI \-S
43 Enables synchronous operation.  Useful for debugging.
44 .SH BUGS
45 Probably.  Please report any you find to http://bugs.freedesktop.org/.
46 .SH AUTHORS
47 Keith Packard, with contributions from Matthew Allum, Eric Anholt, Dan Doel,
48 Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth.