more man page changes

This commit is contained in:
Christopher Jeffrey 2012-10-22 11:56:44 -05:00
parent 7e1a7ee120
commit 1ce58afb1d
3 changed files with 59 additions and 20 deletions

View File

@ -1,16 +1,20 @@
.ds q \N'34' .ds q \N'34'
.TH compton\-trans 1 .TH compton\-trans 1
.SH NAME .SH NAME
compton\-trans \- an opacity setter tool compton\-trans \- an opacity setter tool
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B compton-trans [-wncs] [window] -o [opacity] .B compton-trans [-wncs] [window] -o [opacity]
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.B compton-trans .B compton-trans
is a bash script that sets _NET_WM_WINDOW_OPACITY only using standard is a bash script that sets _NET_WM_WINDOW_OPACITY only using standard
command-line utilities for X11, including xprop(1) and xwininfo(1). command-line utilities for X11, including xprop(1) and xwininfo(1).
It is similar to other utilities like transset(1) or transset-df(1). It is similar to other utilities like transset(1) or transset-df(1).
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-w\ window\-id .BI \-w\ window\-id
@ -31,6 +35,7 @@ Specify the new opacity value for the window. This value
can be anywhere from 1-100. If it is prefixed with a plus can be anywhere from 1-100. If it is prefixed with a plus
or minus (+/-), this will increment or decrement from the or minus (+/-), this will increment or decrement from the
target window's current opacity instead. target window's current opacity instead.
.SH EXAMPLES .SH EXAMPLES
.TP .TP
Set window id to opacity of 75%. Set window id to opacity of 75%.
@ -47,7 +52,14 @@ compton-trans -s -o 75
.TP .TP
Increment current window 5% opacity. Increment current window 5% opacity.
compton-trans -c -o +5 compton-trans -c -o +5
.SH BUGS .SH BUGS
Please report any you find to https://github.com/chjj/compton. Please report any you find to https://github.com/chjj/compton.
.SH AUTHORS .SH AUTHORS
Christopher Jeffrey (https://github.com/chjj) Christopher Jeffrey (https://github.com/chjj)
.SH SEE ALSO
.BR compton(1),
.BR xprop(1),
.BR xwininfo(1)

View File

@ -22,6 +22,11 @@ written by Keith Packard). It includes many improvements over the original
xcompmgr, including window frame opacity, inactive window transparency, xcompmgr, including window frame opacity, inactive window transparency,
and shadows on argb windows. and shadows on argb windows.
.SH EXAMPLE
$ compton -cC -i 0.6 -e 0.6 -f
$ compton --config ~/compton.conf
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-d\ display .BI \-d\ display
@ -33,19 +38,19 @@ The blur radius for shadows. (default 12)
.BI \-o\ opacity .BI \-o\ opacity
The translucency for shadows. (default .75) The translucency for shadows. (default .75)
.TP .TP
.BI \-l\ left-offset .BI \-l\ left\-offset
The left offset for shadows. (default -15) The left offset for shadows. (default -15)
.TP .TP
.BI \-t\ top-offset .BI \-t\ top\-offset
The top offset for shadows. (default -15) The top offset for shadows. (default -15)
.TP .TP
.BI \-I\ fade-in-step .BI \-I\ fade\-in\-step
Opacity change between steps while fading in. (default 0.028) Opacity change between steps while fading in. (default 0.028)
.TP .TP
.BI \-O\ fade-out-step .BI \-O\ fade\-out\-step
Opacity change between steps while fading out. (default 0.03) Opacity change between steps while fading out. (default 0.03)
.TP .TP
.BI \-D\ fade-delta-time .BI \-D\ fade\-delta\-time
The time between steps in a fade in milliseconds. (default 10) The time between steps in a fade in milliseconds. (default 10)
.TP .TP
.BI \-m\ opacity .BI \-m\ opacity
@ -77,45 +82,45 @@ Opacity of window titlebars and borders. (0.1 - 1.0)
Don't draw shadows on DND windows Don't draw shadows on DND windows
.TP .TP
.BI \-b .BI \-b
Daemonize process. Daemonize/background process.
.TP .TP
.BI \-S .BI \-S
Enable synchronous operation (for debugging). Enable synchronous operation (for debugging).
.TP .TP
.BI \--config\ path .BI \-\-config\ path
Look for configuration file at the path. Look for configuration file at the path.
.TP .TP
.BI \--shadow-red\ value .BI \-\-shadow\-red\ value
Red color value of shadow (0.0 - 1.0, defaults to 0). Red color value of shadow (0.0 - 1.0, defaults to 0).
.TP .TP
.BI \--shadow-green\ value .BI \-\-shadow\-green\ value
Green color value of shadow (0.0 - 1.0, defaults to 0). Green color value of shadow (0.0 - 1.0, defaults to 0).
.TP .TP
.BI \--shadow-blue\ value .BI \-\-shadow\-blue\ value
Blue color value of shadow (0.0 - 1.0, defaults to 0). Blue color value of shadow (0.0 - 1.0, defaults to 0).
.TP .TP
.BI \--inactive-opacity-override .BI \-\-inactive\-opacity\-override
Inactive opacity set by -i overrides value of _NET_WM_OPACITY. Inactive opacity set by -i overrides value of _NET_WM_OPACITY.
.TP .TP
.BI \--inactive-dim\ value .BI \-\-inactive\-dim\ value
Dim inactive windows. (0.0 - 1.0, defaults to 0) Dim inactive windows. (0.0 - 1.0, defaults to 0)
.TP .TP
.BI \--mark-wmwin-focused .BI \-\-mark\-wmwin\-focused
Try to detect WM windows and mark them as active. Try to detect WM windows and mark them as active.
.TP .TP
.BI \--shadow-exclude\ condition .BI \-\-shadow\-exclude\ condition
Exclude conditions for shadows. Exclude conditions for shadows.
.TP .TP
.BI \--mark-ovredir-focused .BI \--mark\-ovredir\-focused
Mark over-redirect windows as active. Mark over-redirect windows as active.
.TP .TP
.BI \--no-fading-openclose .BI \-\-no\-fading\-openclose
Do not fade on window open/close. Do not fade on window open/close.
.TP .TP
.BI \--shadow-ignore-shaped .BI \-\-shadow\-ignore\-shaped
Do not paint shadows on shaped windows. Do not paint shadows on shaped windows.
.TP .TP
.BI \--detect-rounded-corners .BI \-\-detect\-rounded\-corners
Try to detect windows with rounded corners and don't consider Try to detect windows with rounded corners and don't consider
them shaped windows. them shaped windows.
.TP .TP
@ -135,6 +140,28 @@ flag is "i" (ignore case).
<pattern> is the actual pattern string. <pattern> is the actual pattern string.
.SH CONFIGURATION
(A more robust sample configuration file exists in the compton
repository.)
.B Example
.B ~/compton.conf:
# Shadows
shadow = true;
# Opacity
inactive-opacity = 0.8;
frame-opacity = 0.7;
# Fades
fading = true;
.B Run with:
$ compton --config ~/compton.conf
.SH BUGS .SH BUGS
Please report any you find to https://github.com/chjj/compton. Please report any you find to https://github.com/chjj/compton.
@ -146,4 +173,4 @@ Compton by Christopher Jeffrey, based on Dana Jansens' original work,
with numerous contributions from Richard Grenville. with numerous contributions from Richard Grenville.
.SH SEE ALSO .SH SEE ALSO
.BR compton-trans (1) .BR compton-trans(1)

View File

@ -2983,7 +2983,7 @@ usage(void) {
"-G\n" "-G\n"
" Don't draw shadows on DND windows\n" " Don't draw shadows on DND windows\n"
"-b\n" "-b\n"
" Daemonize process.\n" " Daemonize/background process.\n"
"-S\n" "-S\n"
" Enable synchronous operation (for debugging).\n" " Enable synchronous operation (for debugging).\n"
"--config path\n" "--config path\n"