Go to file

Richard Grenville e912fcde7b Feature #51 : Re-initialize when SIGUSR1 is received - Create a session_t structure, to get rid of most global variables and let information pass in/out mostly through parameters. Huge changes, so bugs may very well appear. I'm worried about resource leakages, in particular. - Add gcc attributes on various functions. - Add Doxygen configuration. - Replace much Xlib Bool with C99 bool. - Add and adjust some comments. - Drop unused parameters from some functions. - Cache default Visual and Depth, mainly to shorten code. - Rename some types, variables, and functions. - Add win_ev_stop() and set_ignore_next() for convenience. - Modify wid_get_prop_wintype() and wid_get_opacity_prop() to use wid_get_prop(). - Rename --respect-attr-shadow to --respect-prop-shadow. - Fix a memory leak in --respect-prop-shadow. - Many other small changes.		2012-11-19 11:44:58 +08:00
bin	Merge branch 'master' into richardgv-dev	2012-11-14 18:46:26 +08:00
man	Misc: Documentation updates	2012-11-14 20:44:31 +08:00
src	Feature #51 : Re-initialize when SIGUSR1 is received	2012-11-19 11:44:58 +08:00
.gitignore	Feature #51 : Re-initialize when SIGUSR1 is received	2012-11-19 11:44:58 +08:00
CPackConfig.cmake	Bug fix: Window rendered incorrectly if has no border with -e	2012-11-06 11:37:29 +08:00
Doxyfile	Feature #51 : Re-initialize when SIGUSR1 is received	2012-11-19 11:44:58 +08:00
LICENSE	update readme and man page.	2012-10-22 07:50:18 -05:00
Makefile	Misc: Asciidoc man page update	2012-11-05 18:06:31 +08:00
README.md	Misc: Documentation updates	2012-11-14 20:44:31 +08:00
_CMakeLists.txt	Merge branch 'master' into richardgv-dev	2012-11-14 18:46:26 +08:00
compton.sample.conf	Misc: Code cleanup	2012-11-14 21:34:51 +08:00
desc.txt	Misc: #49 : Add CMake support	2012-10-03 13:34:54 +08: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
configuration files (specified with --config)
colored shadows (with --shadow-[red/green/blue] value)
a new fade system
vsync (still under development)
several more options

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)
fixed the conflict with chromium and similar windows
many more

Building

Dependencies:

B for build-time

R for runtime

libx11 (B,R)
libxcomposite (B,R)
libxdamage (B,R)
libxfixes (B,R)
libXext (B,R)
libxrender (B,R)
libXrandr (B,R)
pkg-config (B)
make (B)
xproto / x11proto (B)
bash (R)
xprop,xwininfo / x11-utils (R)
libpcre (B,R) (Will probably be made optional soon)
libconfig (B,R) (Will probably be made optional soon)
libdrm (B) (Will probably be made optional soon)
libGL (B,R) (Will probably be made optional soon)
asciidoc (B) (if you wish to run make docs)

How to build

To build, make sure you have the dependencies above:

# Make the main program
$ make
# Make the newer man pages
$ make docs
# Install
$ make install

(Compton does include a _CMakeLists.txt in the tree, but we haven't decided whether we should switch to CMake yet. The Makefile is fully usable right now.)

Known issues

VSync does not work too well. It's widely reported that tearing still happens on the top of the screen. I do not know how to fix the issue.
If --unredir-if-possible is enabled, when compton redirects/unredirects windows, the screen may flicker. Using --paint-on-overlay minimizes the problem from my observation, yet I do not know if there's a cure.
compton may not track focus correctly in all situations. The focus tracking code is experimental. --use-ewmh-active-win might be helpful.
Compton may give ugly shadow to windows with ARGB background if -z is enabled, because compton cannot determine their real shapes. One may have to disable shadows on those windows with window-type-specific settings in configuration file or --shadow-exclude.
There are two sets of man pages in the repository: the man pages in groff format (man/compton.1 & man/compton-trans.1) and the man pages in Asciidoc format (man/compton.1.asciidoc & man/compton-trans.1.asciidoc). The Asciidoc man pages are much more up-to-date than the groff ones, and it is viewable online. As chjj has not yet expressed his attitude towards switching to Asciidoc man pages, I kept both versions. By default the groff version is installed, unless you run make docs.

Usage

Please refer to the Asciidoc man pages (man/compton.1.asciidoc & man/compton-trans.1.asciidoc) for more details and examples.

Note a sample configuration file compton.sample.conf is included in the repository.

Support

Bug reports and feature requests should go to the "Issues" section above.
Our (semi?) official IRC channel is #compton on FreeNode.
Some information is available on the wiki, including (and presently, only includes) a FAQ.

License

Although compton has kind of taken on a life of its own, it was originally an xcompmgr fork. 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
chjj and richardgv

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

Compton is distributed under MIT license, as far as I (richardgv) know. See LICENSE for more info.