summaryrefslogtreecommitdiffstats
path: root/x11vnc/help.c
diff options
context:
space:
mode:
Diffstat (limited to 'x11vnc/help.c')
-rw-r--r--x11vnc/help.c76
1 files changed, 68 insertions, 8 deletions
diff --git a/x11vnc/help.c b/x11vnc/help.c
index 73d5c86..6592407 100644
--- a/x11vnc/help.c
+++ b/x11vnc/help.c
@@ -2028,17 +2028,49 @@ void print_help(int mode) {
" If this method is successful, the changes required for\n"
" clients to do this less awkwardly will be investigated.\n"
"\n"
-" Note that this mode consumes a lot of memory, both\n"
-" on the x11vnc server side and on the VNC Viewer side.\n"
-" If n=2 then the amount of RAM used is roughly tripled\n"
-" for both x11vnc and the VNC Viewer. As a rule of\n"
-" thumb, note that 1280x1024 at depth 24 is about 5MB of\n"
-" pixel data.\n"
+" Note that this mode consumes a huge amount of memory,\n"
+" both on the x11vnc server side and on the VNC Viewer\n"
+" side. If n=2 then the amount of RAM used is roughly\n"
+" tripled for both x11vnc and the VNC Viewer. As a rule\n"
+" of thumb, note that 1280x1024 at depth 24 is about 5MB\n"
+" of pixel data.\n"
+"\n"
+" For reasonable response when cycling through 4 to 6\n"
+" large (e.g. web browser) windows a value n of 6 to 12\n"
+" is recommended. (that's right: ~10X more memory...)\n"
"\n"
" Because of the way window backingstore and saveunders\n"
" are implemented, n must be even. It will be incremented\n"
" by 1 if it is not.\n"
"\n"
+" This mode also works for native MacOS X, but may not\n"
+" be as effective as the X version. This is due to a\n"
+" number of things, one is the drop-shadow compositing\n"
+" that leaves extra areas that need to be repaired (see\n"
+" -ncache_pad). Another is the window iconification\n"
+" animations need to be avoided (see -macicontime).\n"
+" It appears the that the 'Scale' animation mode gives\n"
+" better results than the 'Genie' one. Also, window event\n"
+" detection not as accurate as the X version.\n"
+"\n"
+"-ncache_cr In -nache mode, try do to copyrect opaque window\n"
+" moves/drags instead of wireframes (this can induce\n"
+" painting errors). The wireframe will still be used when\n"
+" moving a window whose save-unders has not yet been set\n"
+" or has been invalidated.\n"
+"\n"
+" Some VNC Viewers provide better response than others\n"
+" with this option. On Unix, realvnc viewer gives\n"
+" smoother drags than tightvnc viewer. Response may also\n"
+" be choppy if the server side machine is too slow.\n"
+"\n"
+"-ncache_pad n In -nache mode, pad each window with n pixels for the\n"
+" caching rectangles. This can be used to try to improve\n"
+" the situation with dropshadows or other compositing\n"
+" (e.g. MacOS X window manager), although it could make\n"
+" things worse. The default is 0 on Unix and 24 on\n"
+" MacOS X.\n"
+"\n"
#endif
"-wireframe [str] Try to detect window moves or resizes when a mouse\n"
"-nowireframe button is held down and show a wireframe instead of\n"
@@ -2975,6 +3007,13 @@ void print_help(int mode) {
"-macnoresize For the native Mac OS X server, do not resize or reset\n"
" the framebuffer even if it is detected that the screen\n"
" resolution or depth has changed.\n"
+"-maciconanim n For the native Mac OS X server, set n to the number\n"
+" of milliseconds that the window iconify/deiconify\n"
+" animation takes. In -ncache mode this value will be\n"
+" used to skip the animation if possible. (default 400)\n"
+"-macmenu For the native Mac OS X server, in -ncache client-side\n"
+" caching mode, try to cache pull down menus (not perfect\n"
+" because they have animated fades, etc.)\n"
"\n"
"-gui [gui-opts] Start up a simple tcl/tk gui based on the the remote\n"
" control options -remote/-query described below.\n"
@@ -3285,6 +3324,11 @@ void print_help(int mode) {
" buttonmap:str set -buttonmap \"str\", empty to disable\n"
" dragging disable -nodragging mode.\n"
" nodragging enable -nodragging mode.\n"
+" ncache reenable -ncache mode.\n"
+" noncache disable -ncache mode.\n"
+" ncache_size:n set -ncache size to n.\n"
+" ncache_cr enable -ncache_cr mode.\n"
+" noncache_cr disable -ncache_cr mode.\n"
" wireframe enable -wireframe mode. same as \"wf\"\n"
" nowireframe disable -wireframe mode. same as \"nowf\"\n"
" wireframe:str enable -wireframe mode string.\n"
@@ -3350,6 +3394,16 @@ void print_help(int mode) {
" rfbport:n set -rfbport to n.\n"
" macnosaver enable -macnosaver mode.\n"
" macsaver disable -macnosaver mode.\n"
+" macnowait enable -macnowait mode.\n"
+" macwait disable -macnowait mode.\n"
+" macwheel:n set -macwheel to n.\n"
+" macnoswap enable -macnoswap mouse button mode.\n"
+" macswap disable -macnoswap mouse button mode.\n"
+" macnoresize enable -macnoresize mode.\n"
+" macresize disable -macnoresize mode.\n"
+" maciconanim:n set -maciconanim to n.\n"
+" macmenu enable -macmenu mode.\n"
+" macnomenu disable -macnmenu mode.\n"
/* access */
" httpport:n set -httpport to n.\n"
" httpdir:dir set -httpdir to dir (and enable http).\n"
@@ -3439,7 +3493,8 @@ void print_help(int mode) {
" xdamage noxdamage xd_area xd_mem alphacut alphafrac\n"
" alpharemove noalpharemove alphablend noalphablend\n"
" xwarppointer xwarp noxwarppointer noxwarp buttonmap\n"
-" dragging nodragging wireframe_mode wireframe wf\n"
+" dragging nodragging ncache_cr noncache_cr ncache\n"
+" noncache ncache_size wireframe_mode wireframe wf\n"
" nowireframe nowf wireframelocal wfl nowireframelocal\n"
" nowfl wirecopyrect wcr nowirecopyrect nowcr scr_area\n"
" scr_skip scr_inc scr_keys scr_term scr_keyrepeat\n"
@@ -3462,7 +3517,10 @@ void print_help(int mode) {
" debug_wireframe debug_scroll nodebug_scroll debug_scroll\n"
" debug_tiles dbt nodebug_tiles nodbt debug_tiles\n"
" debug_grabs nodebug_grabs debug_sel nodebug_sel dbg\n"
-" nodbg macnosaver macsaver noremote\n"
+" nodbg macnosaver macsaver nomacnosaver macnowait macwait\n"
+" nomacnowait macwheel macnoswap macswap nomacnoswap\n"
+" macnoresize macresize nomacnoresize maciconanim macmenu\n"
+" macnomenu nomacmenu noremote\n"
"\n"
" aro= noop display vncdisplay desktopname guess_desktop\n"
" http_url auth xauth users rootshift clipshift\n"
@@ -3479,6 +3537,8 @@ void print_help(int mode) {
" mouse_x mouse_y bpp depth indexed_color dpy_x dpy_y\n"
" wdpy_x wdpy_y off_x off_y cdpy_x cdpy_y coff_x coff_y\n"
" rfbauth passwd viewpasswd\n"
+"\n"
+"\n"
"-QD variable Just like -query variable, but returns the default\n"
" value for that parameter (no running x11vnc server\n"
" is consulted)\n"