add a man page

diff --git a/ChangeLog b/ChangeLog
index 0a87f12..dfa1cc7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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>
 
        * xcompmgr.c: (error), (usage), (main):
 2004-08-14  Keith Packard  <keithp@keithp.com>
 
        * xcompmgr.c: (error), (usage), (main):

diff --git a/Makefile.am b/Makefile.am
index 16d34d0..96c4dfd 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,5 @@
 bin_PROGRAMS = xcompmgr
 bin_PROGRAMS = xcompmgr

+man_MANS = xcompmgr.man

 
 xcompmgr_LDADD = @XCOMPMGR_LIBS@ -lm
 
 
 xcompmgr_LDADD = @XCOMPMGR_LIBS@ -lm
 

diff --git a/xcompmgr.man b/xcompmgr.man
new file mode 100644 (file)
index 0000000..9646b5f
--- /dev/null
+++ b/xcompmgr.man
@@ -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.