Skip to content

Commit

Permalink
readme, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
chjj committed Nov 7, 2011
1 parent f46a8d0 commit e7ee701
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 21 deletions.
4 changes: 3 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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

Expand Down
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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.
6 changes: 3 additions & 3 deletions compton.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
5 changes: 4 additions & 1 deletion compton.c
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down Expand Up @@ -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");
Expand Down

0 comments on commit e7ee701

Please sign in to comment.