aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2014-10-20 17:57:04 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2014-10-20 18:00:52 -0700
commit14bfab3bb34f5ab75f2ac6c4acb3b67201e89a69 (patch)
tree55919167f7c1c44e11887c6f4e9407ca922b7997 /man
parentman: note that -n is the default mode. (diff)
downloadxcman-14bfab3bb34f5ab75f2ac6c4acb3b67201e89a69.tar.gz
xcman-14bfab3bb34f5ab75f2ac6c4acb3b67201e89a69.tar.bz2
xcman-14bfab3bb34f5ab75f2ac6c4acb3b67201e89a69.tar.xz
config: move man pages into their own directory
Use services provided by XORG_MANPAGE_SECTIONS. Use standard Makefile for man pages. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am12
-rw-r--r--man/xcompmgr.man69
2 files changed, 81 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..988f6ff
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,12 @@
+
+appmandir = $(APP_MAN_DIR)
+appman_PRE = xcompmgr.man
+appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))
+
+EXTRA_DIST = $(appman_PRE)
+CLEANFILES = $(appman_DATA)
+SUFFIXES = .$(APP_MAN_SUFFIX) .man
+
+# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
+.man.$(APP_MAN_SUFFIX):
+ $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
diff --git a/man/xcompmgr.man b/man/xcompmgr.man
new file mode 100644
index 0000000..5f51ac5
--- /dev/null
+++ b/man/xcompmgr.man
@@ -0,0 +1,69 @@
+.ds q \N'34'
+.TH xcompmgr 1 __xorgversion__
+.SH NAME
+xcompmgr \- sample X compositing manager
+.SH SYNOPSIS
+.BI "xcompmgr [\-d " display "] [\-r " radius "]"
+.BI "[\-o " opacity "] [\-l " left-offset "]"
+.BI "[\-t " top-offset "] [\-acCfFnsS]"
+.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 \-d\ display
+Specifies the display to manage.
+.TP
+.BI \-r\ radius
+Specifies the blur radius for client-side shadows.
+.TP
+.BI \-o\ opacity
+Specifies the opacity for client-side shadows.
+.TP
+.BI \-l\ left-offset
+Specifies the left offset for client-side shadows.
+.TP
+.BI \-t\ top-offset
+Specifies the top offset for client-side shadows.
+.TP
+.BI \-I\ fade-in-step
+Specifies the opacity change between steps while fading in.
+.TP
+.BI \-O\ fade-out-step
+Specifies the opacity change between steps while fading out.
+.TP
+.BI \-D\ fade-delta
+Specifies the time (in milliseconds) between steps in a fade.
+.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, and for all windows on hide and restore events.
+.TP
+.BI \-n
+Simple client-side compositing. This is the default mode.
+.TP
+.BI \-s
+Server-side compositing with hard-edged shadows.
+.TP
+.BI \-C
+When \-c is specified, attempts to avoid painting shadows on panels and docks.
+.TP
+.BI \-F
+When \-f is specified, also enables the fade effect when windows change their
+opacity, as with transset(1).
+.TP
+.BI \-S
+Enables synchronous operation. Useful for debugging.
+.SH BUGS
+Probably. Please report any you find to http://bugs.freedesktop.org/.
+.SH AUTHORS
+Keith Packard, with contributions from Matthew Allum, Eric Anholt, Dan Doel,
+Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth.