Misc #205: Add 2 long options & Update documentation

- Add two long variants of short options.

- Update documentation.
This commit is contained in:
Richard Grenville 2014-06-15 11:51:59 +08:00
parent dffd5a5f34
commit 3a3e1387ac
2 changed files with 14 additions and 3 deletions

View File

@ -47,7 +47,7 @@ OPTIONS
*-O*, *--fade-out-step*='OPACITY_STEP':: *-O*, *--fade-out-step*='OPACITY_STEP'::
Opacity change between steps while fading out. (0.01 - 1.0, defaults to 0.03) Opacity change between steps while fading out. (0.01 - 1.0, defaults to 0.03)
*-D* 'MILLISECONDS':: *-D*, *--fade-delta*='MILLISECONDS'::
The time between steps in fade step, in milliseconds. (> 0, defaults to 10) The time between steps in fade step, in milliseconds. (> 0, defaults to 10)
*-m*, *--menu-opacity*='OPACITY':: *-m*, *--menu-opacity*='OPACITY'::
@ -66,7 +66,7 @@ OPTIONS
Fade windows in/out when opening/closing and when opacity changes, unless *--no-fading-openclose* is used. Fade windows in/out when opening/closing and when opacity changes, unless *--no-fading-openclose* is used.
*-F*:: *-F*::
Equals *-f*. Deprecated. Equals to *-f*. Deprecated.
*-i*, *--inactive-opacity*='OPACITY':: *-i*, *--inactive-opacity*='OPACITY'::
Opacity of inactive windows. (0.1 - 1.0, disabled by default) Opacity of inactive windows. (0.1 - 1.0, disabled by default)
@ -77,7 +77,7 @@ OPTIONS
*-G*, *--no-dnd-shadow*:: *-G*, *--no-dnd-shadow*::
Don't draw shadows on drag-and-drop windows. Don't draw shadows on drag-and-drop windows.
*-b*:: *-b*, *--daemon*::
Daemonize process. Fork to background after initialization. Daemonize process. Fork to background after initialization.
*-S*:: *-S*::
@ -119,6 +119,9 @@ OPTIONS
*--no-fading-openclose*:: *--no-fading-openclose*::
Do not fade on window open/close. Do not fade on window open/close.
*--no-fading-destroyed-argb*::
Do not fade destroyed ARGB windows with WM frame. Workaround of bugs in Openbox, Fluxbox, etc.
*--shadow-ignore-shaped*:: *--shadow-ignore-shaped*::
Do not paint shadows on shaped windows. Note shaped windows here means windows setting its shape through X Shape extension. Those using ARGB background is beyond our control. Do not paint shadows on shaped windows. Note shaped windows here means windows setting its shape through X Shape extension. Those using ARGB background is beyond our control.
@ -264,6 +267,12 @@ May also be one of the predefined kernels: `3x3box` (default), `5x5box`, `7x7box
*--xrender-sync-fence*:: *--xrender-sync-fence*::
Additionally use X Sync fence to sync clients' draw calls. Needed on nvidia-drivers with GLX backend for some users. May be disabled at compile time with `NO_XSYNC=1`. Additionally use X Sync fence to sync clients' draw calls. Needed on nvidia-drivers with GLX backend for some users. May be disabled at compile time with `NO_XSYNC=1`.
*--glx-fshader-win* 'SHADER'::
GLX backend: Use specified GLSL fragment shader for rendering window contents. See `compton-default-fshader-win.glsl` and `compton-fake-transparency-fshader-win.glsl` in the source tree for examples.
*--force-win-blend*::
Force all windows to be painted with blending. Useful if you have a *--glx-fshader-win* that could turn opaque pixels transparent.
*--dbus*:: *--dbus*::
Enable remote control via D-Bus. See the *D-BUS API* section below for more details. Enable remote control via D-Bus. See the *D-BUS API* section below for more details.

View File

@ -5543,6 +5543,7 @@ get_cfg(session_t *ps, int argc, char *const *argv, bool first_pass) {
{ "shadow-offset-y", required_argument, NULL, 't' }, { "shadow-offset-y", required_argument, NULL, 't' },
{ "fade-in-step", required_argument, NULL, 'I' }, { "fade-in-step", required_argument, NULL, 'I' },
{ "fade-out-step", required_argument, NULL, 'O' }, { "fade-out-step", required_argument, NULL, 'O' },
{ "fade-delta", required_argument, NULL, 'D' },
{ "menu-opacity", required_argument, NULL, 'm' }, { "menu-opacity", required_argument, NULL, 'm' },
{ "shadow", no_argument, NULL, 'c' }, { "shadow", no_argument, NULL, 'c' },
{ "no-dock-shadow", no_argument, NULL, 'C' }, { "no-dock-shadow", no_argument, NULL, 'C' },
@ -5550,6 +5551,7 @@ get_cfg(session_t *ps, int argc, char *const *argv, bool first_pass) {
{ "fading", no_argument, NULL, 'f' }, { "fading", no_argument, NULL, 'f' },
{ "inactive-opacity", required_argument, NULL, 'i' }, { "inactive-opacity", required_argument, NULL, 'i' },
{ "frame-opacity", required_argument, NULL, 'e' }, { "frame-opacity", required_argument, NULL, 'e' },
{ "daemon", no_argument, NULL, 'b' },
{ "no-dnd-shadow", no_argument, NULL, 'G' }, { "no-dnd-shadow", no_argument, NULL, 'G' },
{ "shadow-red", required_argument, NULL, 257 }, { "shadow-red", required_argument, NULL, 257 },
{ "shadow-green", required_argument, NULL, 258 }, { "shadow-green", required_argument, NULL, 258 },