From e7ee7018a4c4192b3a4336f13f7ec39d9bdac49e Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Sun, 6 Nov 2011 22:03:18 -0600 Subject: [PATCH] readme, etc --- LICENSE | 4 +++- README.md | 34 ++++++++++++++++++---------------- compton.1 | 6 +++--- compton.c | 5 ++++- 4 files changed, 28 insertions(+), 21 deletions(-) diff --git a/LICENSE b/LICENSE index 256a9df6..a64b1488 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,9 @@ compton - a compositor for X11 Based on xcompmgr, originally written by Keith Packard, with modifications -from several contributors. +from several contributors (according to the xcompmgr man page): Matthew Allum, +Eric Anholt, Dan Doel, Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell, +and Carl Worth. Menu transparency was implemented by Dana Jansens. xcompmgr diff --git a/README.md b/README.md index 73139e95..ce29a822 100644 --- a/README.md +++ b/README.md @@ -29,24 +29,9 @@ should work with any window manager that properly sets `_NET_FRAME_EXTENTS`. * fixed a memory leak caused by not freeing up shadows (from the freedesktop repo) -## 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. - -Keith Packard's original license remains in the source. - ## Building -The same dependencies and build as xcompmgr. +The same dependencies as xcompmgr. ### Dependencies: @@ -55,6 +40,8 @@ The same dependencies and build as xcompmgr. * libxdamage * libxfixes * libxrender +* pkg-config +* make To build, make sure you have the above dependencies: @@ -71,3 +58,18 @@ $ compton -cC -t -5 -l -5 -r 5 -o 0.4 \ $ 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. diff --git a/compton.1 b/compton.1 index 9f15ad28..31c16772 100644 --- a/compton.1 +++ b/compton.1 @@ -39,7 +39,7 @@ Specifies the opacity change between steps while fading out. Specifies the time (in milliseconds) between steps in a fade. .TP .BI \-c -Client-side compositing with soft shadows and translucency support. +Enable client-side shadows on windows. .TP .BI \-f When \-c is specified, enables a smooth fade effect for transient windows like @@ -61,9 +61,9 @@ Specifies window frame transparency. (0.1 - 1.0) .BI \-S Enables synchronous operation. Useful for debugging. .SH BUGS -Probably. Please report any you find to https://github.com/chjj/compton. +Please report any you find to https://github.com/chjj/compton. .SH AUTHORS -xcompmgr, Originally written by Keith Packard, with contributions from +xcompmgr, originally written by Keith Packard, with contributions from 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. diff --git a/compton.c b/compton.c index 11654ea1..11981da7 100644 --- a/compton.c +++ b/compton.c @@ -2098,7 +2098,7 @@ ev_window(XEvent *ev) { void usage(char *program) { - fprintf(stderr, "%s v1.1.3\n", program); + fprintf(stderr, "%s v0.0.1\n", program); fprintf(stderr, "usage: %s [options]\n", program); fprintf(stderr, "Options\n"); @@ -2129,6 +2129,9 @@ usage(char *program) { fprintf(stderr, " -m opacity\n " "The opacity for menus. (default 1.0)\n"); + fprintf(stderr, + " -c\n " + "Enabled client-side shadows on windows.\n"); fprintf(stderr, " -C\n " "Avoid drawing shadows on dock/panel windows.\n");