fix man page and various other documentation.
This commit is contained in:
parent
9399db5377
commit
7e1a7ee120
|
@ -63,7 +63,7 @@ $ make install
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
$ compton -cC -i 0.6 -e 0.6 -fF
|
$ compton -cC -i 0.6 -e 0.6 -f
|
||||||
$ compton --config ~/compton.conf
|
$ compton --config ~/compton.conf
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -74,7 +74,7 @@ compton [-d display] [-r radius] [-o opacity]
|
||||||
[-l left-offset] [-t top-offset]
|
[-l left-offset] [-t top-offset]
|
||||||
[-i opacity] [-e opacity] [-cCfFSdG]
|
[-i opacity] [-e opacity] [-cCfFSdG]
|
||||||
[--config path] [--shadow-red value]
|
[--config path] [--shadow-red value]
|
||||||
[--shadow-gren value] [--shadow-blue value]
|
[--shadow-green value] [--shadow-blue value]
|
||||||
[--inactive-opacity-override] [--inactive-dim value]
|
[--inactive-opacity-override] [--inactive-dim value]
|
||||||
[--mark-wmwin-focused] [--shadow-exclude condition]
|
[--mark-wmwin-focused] [--shadow-exclude condition]
|
||||||
[--mark-ovredir-focused] [--no-fading-openclose]
|
[--mark-ovredir-focused] [--no-fading-openclose]
|
||||||
|
@ -116,8 +116,8 @@ compton [-d display] [-r radius] [-o opacity]
|
||||||
Opacity of window titlebars and borders. (0.1 - 1.0)
|
Opacity of window titlebars and borders. (0.1 - 1.0)
|
||||||
* `-G`:
|
* `-G`:
|
||||||
Don't draw shadows on DND windows
|
Don't draw shadows on DND windows
|
||||||
* `-b` __daemonize__:
|
* `-b`:
|
||||||
Daemonize process.
|
Daemonize/background process.
|
||||||
* `-S`:
|
* `-S`:
|
||||||
Enable synchronous operation (for debugging).
|
Enable synchronous operation (for debugging).
|
||||||
* `--config` __path__:
|
* `--config` __path__:
|
||||||
|
|
|
@ -1,24 +1,27 @@
|
||||||
.ds q \N'34'
|
.ds q \N'34'
|
||||||
.TH compton 1
|
.TH compton 1
|
||||||
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
compton \- a compositor for X11
|
compton \- a compositor for X11
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.nf
|
.B compton
|
||||||
.B compton [\-d display] [\-r radius] [\-o opacity] [\-l left-offset]
|
[\-d display] [\-r radius] [\-o opacity] [\-l left\-offset]
|
||||||
[\-t top-offset] [\-i opacity] [\-e opacity] [\-cCfFSdG]
|
[\-t top\-offset] [\-i opacity] [\-e opacity] [\-cCfFSdG]
|
||||||
[\--config path] [\--shadow-red value]
|
[\-\-config path] [\-\-shadow\-red value]
|
||||||
[\--shadow-gren value] [\--shadow-blue value]
|
[\-\-shadow\-green value] [\-\-shadow\-blue value]
|
||||||
[\--inactive-opacity-override] [\--inactive-dim value]
|
[\-\-inactive\-opacity\-override] [\-\-inactive\-dim value]
|
||||||
[\--mark-wmwin-focused] [\--shadow-exclude condition]
|
[\-\-mark\-wmwin\-focused] [\-\-shadow\-exclude condition]
|
||||||
[\--mark-ovredir-focused] [\--no-fading-openclose]
|
[\-\-mark\-ovredir\-focused] [\-\-no\-fading\-openclose]
|
||||||
[\--shadow-ignore-shaped] [\--detect-round-corners]
|
[\-\-shadow\-ignore\-shaped] [\-\-detect\-round\-corners]
|
||||||
.fi
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B compton
|
.B compton
|
||||||
is a compositor based on Dana Jansens' version of xcompmgr (which itself was
|
is a compositor based on Dana Jansens' version of xcompmgr (which itself was
|
||||||
written by Keith Packard). It includes many improvements over the original
|
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 OPTIONS
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
.BI \-d\ display
|
.BI \-d\ display
|
||||||
|
@ -73,7 +76,7 @@ Opacity of window titlebars and borders. (0.1 - 1.0)
|
||||||
.BI \-G
|
.BI \-G
|
||||||
Don't draw shadows on DND windows
|
Don't draw shadows on DND windows
|
||||||
.TP
|
.TP
|
||||||
.BI \-b\ daemonize
|
.BI \-b
|
||||||
Daemonize process.
|
Daemonize process.
|
||||||
.TP
|
.TP
|
||||||
.BI \-S
|
.BI \-S
|
||||||
|
@ -134,9 +137,13 @@ flag is "i" (ignore case).
|
||||||
|
|
||||||
.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
|
||||||
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,
|
Matthew Allum, Eric Anholt, Dan Doel, Thomas Luebking, Matthew Hawn,
|
||||||
Ely Levy, Phil Blundell, and Carl Worth.
|
Ely Levy, Phil Blundell, and Carl Worth.
|
||||||
Compton by Christopher Jeffrey, based on Dana Jansens' original work,
|
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
|
||||||
|
.BR compton-trans (1)
|
||||||
|
|
|
@ -2982,7 +2982,7 @@ usage(void) {
|
||||||
" Opacity of window titlebars and borders. (0.1 - 1.0)\n"
|
" Opacity of window titlebars and borders. (0.1 - 1.0)\n"
|
||||||
"-G\n"
|
"-G\n"
|
||||||
" Don't draw shadows on DND windows\n"
|
" Don't draw shadows on DND windows\n"
|
||||||
"-b daemonize\n"
|
"-b\n"
|
||||||
" Daemonize process.\n"
|
" Daemonize process.\n"
|
||||||
"-S\n"
|
"-S\n"
|
||||||
" Enable synchronous operation (for debugging).\n"
|
" Enable synchronous operation (for debugging).\n"
|
||||||
|
|
Loading…
Reference in New Issue