add a man page

This commit is contained in:
Adam Jackson 2004-09-09 03:27:16 +00:00
parent 576c3c435c
commit ff13f4a4b9
3 changed files with 41 additions and 0 deletions

View File

@ -1,3 +1,8 @@
2004-09-08 Adam Jackson <ajax@freedesktop.org>
* xcompmgr.man, Makefile.am:
Add a man page.
2004-08-14 Keith Packard <keithp@keithp.com> 2004-08-14 Keith Packard <keithp@keithp.com>
* xcompmgr.c: (error), (usage), (main): * xcompmgr.c: (error), (usage), (main):

View File

@ -1,4 +1,5 @@
bin_PROGRAMS = xcompmgr bin_PROGRAMS = xcompmgr
man_MANS = xcompmgr.man
xcompmgr_LDADD = @XCOMPMGR_LIBS@ -lm xcompmgr_LDADD = @XCOMPMGR_LIBS@ -lm

35
xcompmgr.man Normal file
View File

@ -0,0 +1,35 @@
.ds q \N'34'
.TH xcompmgr 1
.SH NAME
xcompmgr \- sample X compositing manager
.SH SYNOPSIS
.nf
.B xcompmgr [\-acfns]
.fi
.SH DESCRIPTION
.B xcompmgr
is a sample compositing manager for X servers supporting the XFIXES, DAMAGE,
and COMPOSITE extensions. It enables basic eye-candy effects.
.SH OPTIONS
.TP
.BI \-a
Automatic server-side compositing. This instructs the server to use the
standard composition rules. Useful for debugging.
.TP
.BI \-c
Client-side compositing with soft shadows and translucency support.
.TP
.BI \-f
When \-c is specified, enables a smooth fade effect for transient windows like
menus.
.TP
.BI \-n
Simple client-side compositing.
.TP
.BI \-s
Server-side compositing with hard-edged shadows.
.SH BUGS
Several.
.SH AUTHORS
Keith Packard, with contributions from Matthew Allum, Eric Anholt,
Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth.