Go to file
Christopher Jeffrey e7ee7018a4 readme, etc 2011-11-06 22:03:18 -06:00
.gitignore clean tree 2011-11-06 18:20:45 -06:00
LICENSE readme, etc 2011-11-06 22:03:18 -06:00
Makefile clean tree 2011-11-06 18:20:45 -06:00
README.md readme, etc 2011-11-06 22:03:18 -06:00
compton.1 readme, etc 2011-11-06 22:03:18 -06:00
compton.c readme, etc 2011-11-06 22:03:18 -06:00
compton.h clean tree 2011-11-06 18:20:45 -06:00

README.md

Compton

Compton is a compositor for X, and a fork of xcompmgr-dana.

I was frustrated by the low amount of standalone lightweight compositors. Compton was forked from Dana Jansens' fork of xcompmgr and refactored. I fixed whatever bug I found, and added features I wanted. Things seem stable, but don't quote me on it. I will most likely be actively working on this until I get the features I want. This is also a learning experience for me. That is, I'm partially doing this out of a desire to learn Xlib.

Changes from xcompmgr:

  • inactive window transparency (specified with -i)
  • titlebar/frame transparency (specified with -e)
  • menu transparency (thanks to Dana)
  • shadows are now enabled for argb windows, e.g. terminals with transparency
  • removed serverside shadows (and simple compositing) to clean the code, the only option that remains is clientside shadows

The above features give compton a feature set similar to the xfce compositor.

Compton has only been tested with openbox so far, but frame transparency should work with any window manager that properly sets _NET_FRAME_EXTENTS.

Fixes from the original xcompmgr:

  • fixed a segfault when opening certain window types
  • fixed a memory leak caused by not freeing up shadows (from the freedesktop repo)

Building

The same dependencies as xcompmgr.

Dependencies:

  • libx11
  • libxcomposite
  • libxdamage
  • libxfixes
  • libxrender
  • pkg-config
  • make

To build, make sure you have the above dependencies:

$ make
$ make install

Usage

$ compton -cC -t -5 -l -5 -r 5 -o 0.4 \
  -fF -I 0.065 -O 0.065 -D 6 -m 0.8 -i 0.6 -e 0.6 &

$ compton -cC -t -5 -l -5 -r 5 -o 0.4 -i 0.6 -e 0.6 &

License

xcompmgr has gotten around. As far as I can tell, the lineage for this particular tree is something like:

  • Keith Packard (original author)
  • Matthew Hawn
  • ...
  • Dana Jansens
  • Myself

Not counting the tens of people who forked it in between.

See LICENSE for more info.