BitHeaven/picom
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Misc: Documentation updates

Browse Source 
Update README.md and two Asciidoc man pages. Remove the options and
examples section in README.md.
This commit is contained in:
Richard Grenville
2012-11-14 20:44:31 +08:00
parent 62ea373ee5
commit 09c10c227c
3 changed files with 38 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
man/compton-trans.1.asciidoc
View File

@ -1,9 +1,9 @@
compton-trans(1)
================
:doctype: manpage
:man source: compton
:man version: nightly-20121105
:man manual: LOCAL USER COMMANDS
:doctype: manpage
:man source: compton
:man version: nightly-20121114
:man manual: LOCAL USER COMMANDS
NAME
----
@ -12,7 +12,7 @@ compton-trans - an opacity setter tool
SYNOPSIS
--------
*compton-trans* [-w 'WINDOW_ID'] [-n 'WINDOW_NAME'] [-c] [-s] [-o 'OPACITY']
*compton-trans* [-w 'WINDOW_ID'] [-n 'WINDOW_NAME'] [-c] [-s] 'OPACITY'
DESCRIPTION
-----------
@ -42,31 +42,37 @@ EXAMPLES
* Set the opacity of the window with specific window ID to 75%:
+
------------
compton-trans -w "$WINDOWID" -o 75
compton-trans -w "$WINDOWID" 75
------------
* Set the opacity of the window with the name "urxvt" to 75%:
+
------------
compton-trans -n "urxvt" -o 75
compton-trans -n "urxvt" 75
------------
* Set current window to opacity of 75%:
+
------------
compton-trans -c -o 75
compton-trans -c 75
------------
* Select target window and set opacity to 75%:
+
------------
compton-trans -s -o 75
compton-trans -s 75
------------
* Increment opacity of current active window for 5%:
* Increment opacity of current active window by 5%:
+
------------
compton-trans -c -o +5
compton-trans -c +5
------------
* Decrement opacity of current active window by 5%:
+
------------
compton-trans -c -- -5
------------
BUGS

11
man/compton.1.asciidoc
View File

@ -1,9 +1,9 @@
compton(1)
==========
:doctype: manpage
:man source: compton
:man version: nightly-20121105
:man manual: LOCAL USER COMMANDS
:doctype: manpage
:man source: compton
:man version: nightly-20121105
:man manual: LOCAL USER COMMANDS
NAME
----
@ -142,6 +142,9 @@ OPTIONS
*--use-ewmh-active-win*::
Use EWMH '_NET_ACTIVE_WINDOW' to determine currently focused window, rather than listening to 'FocusIn'/'FocusOut' event. Might have more accuracy, provided that the WM supports it. Experimental.
*--unredir-if-possible*::
Unredirect all windows if a full-screen opaque window is detected, to maximize performance for full-screen windows. Known to cause flickering when redirecting/unredirecting windows. *--paint-on-overlay* may make the flickering less obvious. Experimental.
FORMAT OF CONDITIONS
--------------------