64959321ffed76f3bff8360e4eaf2ae9b1725e7b
[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 \-a
31 Automatic server-side compositing.  This instructs the server to use the
32 standard composition rules.  Useful for debugging.
33 .TP
34 .BI \-c
35 Client-side compositing with soft shadows and translucency support.
36 .TP
37 .BI \-f
38 When \-c is specified, enables a smooth fade effect for transient windows like
39 menus, and for all windows on hide and restore events.
40 .TP
41 .BI \-n
42 Simple client-side compositing.
43 .TP
44 .BI \-s
45 Server-side compositing with hard-edged shadows.
46 .TP
47 .BI \-C
48 When \-c is specified, attempts to avoid painting shadows on panels and docks.
49 .TP
50 .BI \-F
51 When \-f is specified, also enables the fade effect when windows change their
52 opacity, as with transset(1).
53 .TP
54 .BI \-S
55 Enables synchronous operation.  Useful for debugging.
56 .SH BUGS
57 Probably.  Please report any you find to http://bugs.freedesktop.org/.
58 .SH AUTHORS
59 Keith Packard, with contributions from Matthew Allum, Eric Anholt, Dan Doel,
60 Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth.