add a man page
[dana/xcompmgr.git] / xcompmgr.man
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 [\-acfns]
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 \-a
16 Automatic server-side compositing.  This instructs the server to use the
17 standard composition rules.  Useful for debugging.
18 .TP
19 .BI \-c
20 Client-side compositing with soft shadows and translucency support.
21 .TP
22 .BI \-f
23 When \-c is specified, enables a smooth fade effect for transient windows like
24 menus.
25 .TP
26 .BI \-n
27 Simple client-side compositing.
28 .TP
29 .BI \-s
30 Server-side compositing with hard-edged shadows.
31 .SH BUGS
32 Several.
33 .SH AUTHORS
34 Keith Packard, with contributions from Matthew Allum, Eric Anholt,
35 Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth.