2004-09-08 23:27:16 -04:00
|
|
|
.ds q \N'34'
|
2011-11-06 19:20:45 -05:00
|
|
|
.TH compton 1
|
2004-09-08 23:27:16 -04:00
|
|
|
.SH NAME
|
2011-11-06 19:20:45 -05:00
|
|
|
compton \- a compositor for X11
|
2004-09-08 23:27:16 -04:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
2012-02-26 23:00:12 -05:00
|
|
|
.B compton [\-d display] [\-r radius] [\-o opacity] [\-l left-offset] [\-t top-offset] [\-i opacity] [\-e opacity] [\-cCfFSdG]
|
2004-09-08 23:27:16 -04:00
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2011-11-06 19:20:45 -05:00
|
|
|
.B compton
|
|
|
|
|
is a compositor based on Dana Jansens' version of xcompmgr (which itself was
|
|
|
|
|
written by Keith Packard). It includes many improvements over the original
|
|
|
|
|
xcompmgr, including window frame opacity, inactive window transparency,
|
|
|
|
|
and shadows on argb windows.
|
2004-09-08 23:27:16 -04:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
2004-09-10 01:55:19 -04:00
|
|
|
.BI \-d\ display
|
|
|
|
|
Specifies the display to manage.
|
|
|
|
|
.TP
|
2004-09-17 20:13:15 -04:00
|
|
|
.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
|
2011-11-06 19:20:45 -05:00
|
|
|
Specifies the top offset for client-side shadows.
|
2004-09-17 20:13:15 -04:00
|
|
|
.TP
|
2004-09-23 03:17:48 -04:00
|
|
|
.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
|
2004-09-08 23:27:16 -04:00
|
|
|
.BI \-c
|
2011-11-06 23:03:18 -05:00
|
|
|
Enable client-side shadows on windows.
|
2004-09-08 23:27:16 -04:00
|
|
|
.TP
|
|
|
|
|
.BI \-f
|
|
|
|
|
When \-c is specified, enables a smooth fade effect for transient windows like
|
2004-09-10 01:55:19 -04:00
|
|
|
menus, and for all windows on hide and restore events.
|
2004-09-08 23:27:16 -04:00
|
|
|
.TP
|
2004-09-10 01:55:19 -04:00
|
|
|
.BI \-C
|
|
|
|
|
When \-c is specified, attempts to avoid painting shadows on panels and docks.
|
|
|
|
|
.TP
|
2012-02-26 11:35:17 -05:00
|
|
|
.BI \-G
|
|
|
|
|
When \-c is specified, attempts to avoid painting shadows on
|
|
|
|
|
drag-and-drop windows.
|
|
|
|
|
.TP
|
2004-09-10 01:55:19 -04:00
|
|
|
.BI \-F
|
|
|
|
|
When \-f is specified, also enables the fade effect when windows change their
|
|
|
|
|
opacity, as with transset(1).
|
|
|
|
|
.TP
|
2012-02-26 12:02:42 -05:00
|
|
|
.BI \-b
|
2012-02-26 23:00:12 -05:00
|
|
|
Attempt to fork to background after registering compositor.
|
2012-02-26 12:02:42 -05:00
|
|
|
.TP
|
2011-11-06 19:20:45 -05:00
|
|
|
.BI \-i\ opacity
|
|
|
|
|
Specifies inactive window transparency. (0.1 - 1.0)
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-e\ opacity
|
|
|
|
|
Specifies window frame transparency. (0.1 - 1.0)
|
|
|
|
|
.TP
|
2004-09-10 01:55:19 -04:00
|
|
|
.BI \-S
|
|
|
|
|
Enables synchronous operation. Useful for debugging.
|
2004-09-08 23:27:16 -04:00
|
|
|
.SH BUGS
|
2011-11-06 23:03:18 -05:00
|
|
|
Please report any you find to https://github.com/chjj/compton.
|
2004-09-08 23:27:16 -04:00
|
|
|
.SH AUTHORS
|
2011-11-06 23:03:18 -05:00
|
|
|
xcompmgr, originally written by Keith Packard, with contributions from
|
2011-11-06 19:20:45 -05:00
|
|
|
Matthew Allum, Eric Anholt, Dan Doel, Thomas Luebking, Matthew Hawn,
|
|
|
|
|
Ely Levy, Phil Blundell, and Carl Worth.
|
|
|
|
|
Compton by Christopher Jeffrey, based on Dana Jansens' original work.
|
