summaryrefslogtreecommitdiffstats
path: root/x11vnc/help.c
diff options
context:
space:
mode:
Diffstat (limited to 'x11vnc/help.c')
-rw-r--r--x11vnc/help.c57
1 files changed, 44 insertions, 13 deletions
diff --git a/x11vnc/help.c b/x11vnc/help.c
index 4b81efe..279c964 100644
--- a/x11vnc/help.c
+++ b/x11vnc/help.c
@@ -176,6 +176,21 @@ void print_help(int mode) {
" shifts a root view to it: this shows SaveUnders menus,\n"
" etc, although they will be clipped if they extend beyond\n"
" the window.\n"
+"\n"
+"-appshare Simple application sharing based on the -id/-sid\n"
+" mechanism. Every new toplevel window that the\n"
+" application creates induces a new viewer window via\n"
+" a reverse connection. The -id/-sid and -connect\n"
+" options are required. Run 'x11vnc -appshare -help'\n"
+" for more info.\n"
+"\n"
+#if 0
+"-freeze_when_obscured Probably only of use in -appshare mode: if the -id/-sid\n"
+" window is partially or fully obscured by other windows,\n"
+" stop checking for framebuffer updates. Mouse and\n"
+" keyboard events are still processed and injected.\n"
+"\n"
+#endif
"-clip WxH+X+Y Only show the sub-region of the full display that\n"
" corresponds to the rectangle geometry with size WxH and\n"
" offset +X+Y. The VNC display has size WxH (i.e. smaller\n"
@@ -2779,7 +2794,7 @@ void print_help(int mode) {
" \"debug crash shell\" when fatal errors are trapped.\n"
"\n"
"-q, -quiet Be quiet by printing less informational output to\n"
-" stderr.\n"
+" stderr. (use -noquiet to undo an earlier -quiet.)\n"
"-v, -verbose Print out more information to stderr.\n"
"\n"
"-bg Go into the background after screen setup. Messages to\n"
@@ -3175,7 +3190,7 @@ void print_help(int mode) {
" (an integer) times that of the full display is allocated\n"
" below the actual framebuffer to cache screen contents\n"
" for rapid retrieval. So a W x H frambuffer is expanded\n"
-" to a W x (n+1)*H one. Use 0 to disable. Default: XXX.\n"
+" to a W x (n+1)*H one. Use 0 to disable.\n"
"\n"
" The \"n\" is actually optional, the default is 10.\n"
"\n"
@@ -3183,13 +3198,17 @@ void print_help(int mode) {
" abbreviate \"-ncache\" with \"-nc\". Also, \"-nonc\"\n"
" is the same as \"-ncache 0\"\n"
"\n"
-" This is an experimental option, currently implemented\n"
-" in an awkward way in that in the VNC Viewer you can\n"
-" see the cache contents if you scroll down, etc. So you\n"
+" This is an experimental option, currently implemented in\n"
+" an awkward way in that in the VNC Viewer you can see the\n"
+" pixel cache contents if you scroll down, etc. So you\n"
" will have to set things up so you can't see that region.\n"
" If this method is successful, the changes required for\n"
" clients to do this less awkwardly will be investigated.\n"
"\n"
+" The SSVNC viewer does a good job at automatically hiding\n"
+" the pixel cache region. Or use SSVNC's -ycrop option\n"
+" to explicitly hide the region.\n"
+"\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"
@@ -3896,10 +3915,7 @@ void print_help(int mode) {
" for output) are created to handle each new client.\n"
" Default: %s.\n"
"\n"
-" NOTE: The -threads mode may be disabled due to its\n"
-" unstable behavior. If it is disabled, a warning is\n"
-" printed out. Stability has been improved in version\n"
-" 0.9.8 and so the feature has been re-enabled.\n"
+" Thread stability is much improved in version 0.9.8.\n"
"\n"
" Multiple clients in threaded mode should be stable\n"
" for the ZRLE encoding on all platforms. The Tight and\n"
@@ -3907,9 +3923,14 @@ void print_help(int mode) {
" multiple clients. Compile with -DTLS=__thread if your\n"
" OS and compiler and linker support it.\n"
"\n"
+" For resizes (randr, etc.) set this env. var. to the number\n"
+" of milliseconds to sleep: X11VNC_THREADS_NEW_FB_SLEEP\n"
+" at various places in the do_new_fb() action. This is to\n"
+" let various activities settle. Default is about 500ms.\n"
+"\n"
" Multiple clients in threaded mode could yield better\n"
-" performance for 'class-room' broadcasting usage.\n"
-" See also the -reflect option.\n"
+" performance for 'class-room' broadcasting usage; also in\n"
+" -appshare broadcast mode. See also the -reflect option.\n"
"\n"
"-fs f If the fraction of changed tiles in a poll is greater\n"
" than f, the whole screen is updated. Default: %.2f\n"
@@ -4599,6 +4620,12 @@ void print_help(int mode) {
" id:windowid set -id window to \"windowid\". empty\n"
" or \"root\" to go back to root window\n"
" sid:windowid set -sid window to \"windowid\"\n"
+" id_cmd:cmd cmds: raise, lower, map, unmap, iconify,\n"
+" move:dXdY, resize:dWdH, geom:WxH+X+Y. dX\n"
+" dY, dW, and dH must have a leading \"+\"\n"
+" or \"-\" e.g.: move:-30+10 resize:+20+35\n"
+" also: wm_delete, wm_name:string and\n"
+" icon_name:string. Also id_cmd:win=N:cmd\n"
" waitmapped wait until subwin is mapped.\n"
" nowaitmapped do not wait until subwin is mapped.\n"
" clip:WxH+X+Y set -clip mode to \"WxH+X+Y\"\n"
@@ -5081,8 +5108,8 @@ void print_help(int mode) {
" file use \"qry=...\" instead of \"cmd=...\"\n"
"\n"
" ans= stop quit exit shutdown ping resend_cutbuffer\n"
-" resend_clipboard resend_primary blacken zero\n"
-" refresh reset close disconnect id sid waitmapped\n"
+" resend_clipboard resend_primary blacken zero refresh\n"
+" reset close disconnect id_cmd id sid waitmapped\n"
" nowaitmapped clip flashcmap noflashcmap shiftcmap\n"
" truecolor notruecolor overlay nooverlay overlay_cursor\n"
" overlay_yescursor nooverlay_nocursor nooverlay_cursor\n"
@@ -5224,6 +5251,10 @@ void print_help(int mode) {
" The returned output is also prefixed with \"str\".\n"
" Example: -remote_prefix DO_THIS:\n"
"\n"
+" Note that enabling -remote_prefix allows the remote\n"
+" VNC viewers to run x11vnc -remote commands. Do not\n"
+" use this option if they are not to be trusted.\n"
+"\n"
"-noremote Do not process any remote control commands or queries.\n"
"-yesremote Do process remote control commands or queries.\n"
" Default: %s\n"