Merge branch 'master' into richardgv-dev

Conflicts:
	bin/compton-trans
	man/compton-trans.1

- Add some explaination in README.md.

- Rename CMakeLists.txt to _CMakeLists.txt to avoid confusion.
This commit is contained in:
Richard Grenville 2012-11-14 18:42:09 +08:00
commit 62ea373ee5
4 changed files with 69 additions and 54 deletions

View File

@ -57,13 +57,21 @@ __R__ for runtime
* libGL (B,R) (Will probably be made optional soon)
* asciidoc (B) (if you wish to run `make docs`)
To build, make sure you have the above dependencies:
### How to build
To build, make sure you have the dependencies above:
``` bash
# 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.)
## Example Usage
``` bash

View File

@ -1,19 +1,23 @@
#!/bin/bash
#
# compton-trans
# transset in a bash script
# Copyright (c) 2011-2012, Christopher Jeffrey
#
# Usage:
# by window id
# settrans -w "$WINDOWID" -o 75
# by name
# settrans -n "urxvt" -o 75
# by current window
# settrans -c -o 75
# by selection
# settrans -s -o 75
# increment current window 5%
# settrans -c -o +5
# By window id
# $ compton-trans -w "$WINDOWID" 75
# By name
# $ compton-trans -n "urxvt" 75
# By current window
# $ compton-trans -c 75
# By selection
# $ compton-trans 75
# $ compton-trans -s 75
# Increment current window 5%
# $ compton-trans -c +5
# "command" is a shell built-in, faster than "which"
if test -z "$(command -v xprop)" -o -z "$(command -v xwininfo)"; then

View File

@ -39,19 +39,22 @@ target window's current opacity instead.
.SH EXAMPLES
.TP
Set window id to opacity of 75%.
compton-trans -w "$WINDOWID" -o 75
compton-trans -w "$WINDOWID" 75
.TP
Set window name, "urxvt", to opacity of 75%.
compton-trans -n "urxvt" -o 75
compton-trans -n "urxvt" 75
.TP
Set current window to opacity of 75%.
compton-trans -c -o 75
compton-trans -c 75
.TP
Select target window and set opacity to 75%.
compton-trans -s -o 75
compton-trans -s 75
.TP
Increment current window 5% opacity.
compton-trans -c -o +5
Increment current window opacity by 5%.
compton-trans -c +5
.TP
Decrement current window opacity by 5%.
compton-trans -c -- -5
.SH BUGS
Please report any you find to https://github.com/chjj/compton.