summaryrefslogtreecommitdiffstats
path: root/x11vnc/help.c
diff options
context:
space:
mode:
Diffstat (limited to 'x11vnc/help.c')
-rw-r--r--x11vnc/help.c54
1 files changed, 51 insertions, 3 deletions
diff --git a/x11vnc/help.c b/x11vnc/help.c
index 0b8e70c..e135d16 100644
--- a/x11vnc/help.c
+++ b/x11vnc/help.c
@@ -429,6 +429,46 @@ void print_help(int mode) {
" Be careful about the location of this file if x11vnc\n"
" is running as root (e.g. via gdm(1), etc).\n"
"\n"
+"\n"
+" Repeater mode: Some services provide an intermediate\n"
+" \"vnc repeater\": http://www.uvnc.com/addons/repeater.html\n"
+" (and also http://koti.mbnet.fi/jtko/ for linux port)\n"
+" that acts as a proxy / gateway. Modes like these require\n"
+" an initial string to be sent for the reverse connection\n"
+" before the VNC protocol is started. Here are the ways\n"
+" to do this:\n"
+"\n"
+" -connect pre=some_string+host:port\n"
+" -connect pre128=some_string+host:port\n"
+" -connect repeater=ID:1234+host:port\n"
+" -connect repeater=23.45.67.89::5501+host:port\n"
+"\n"
+" SSVNC notation is also supported:\n"
+"\n"
+" -connect repeater://host:port+ID:1234\n"
+"\n"
+" As with normal -connect usage, if the repeater port is\n"
+" not supplied 5500 is assumed.\n"
+"\n"
+" The basic idea is between the special tag, e.g. \"pre=\"\n"
+" and \"+\" is the pre-string to be sent. Note that in\n"
+" this case host:port is the repeater server, NOT the\n"
+" vnc viewer. Somehow the pre-string tells the repeater\n"
+" server how to find the vnc viewer and connect you to it.\n"
+"\n"
+" In the case pre=some_string+host:port, \"some_string\"\n"
+" is simply sent. In the case preNNN=some_string+host:port\n"
+" \"some_string\" is sent in a null padded buffer of\n"
+" length NNN. repeater= is the same as pre250=, this is\n"
+" the ultravnc repeater buffer size.\n"
+"\n"
+" Strings like \"\\n\" and \"\\r\", etc. are expanded to\n"
+" newline and carriage return. \"\\c\" is expanded to\n"
+" \",\" since the connect string is comma separated.\n"
+"\n"
+" See also the -proxy option below for additional ways\n"
+" to plumb reverse connections.\n"
+"\n"
"-connect_or_exit str As with -connect, except if none of the reverse\n"
" connections succeed, then x11vnc shutdowns immediately.\n"
"\n"
@@ -896,6 +936,10 @@ void print_help(int mode) {
" and so \"-ssl SAVE -redirect host:port\" can act as a\n"
" replacement for stunnel(1).\n"
"\n"
+" This mode only allows one redirected connection.\n"
+" The -forever option does not apply. Use -inetd or\n"
+" -loop for persistant service.\n"
+"\n"
"-display WAIT:... A special usage mode for the normal -display option.\n"
" Useful with -unixpw, but can be used independently\n"
" of it. If the display string begins with WAIT: then\n"
@@ -3075,8 +3119,8 @@ void print_help(int mode) {
"-forcedpms If the system supports the DPMS (Display Power\n"
" Management Signaling) extension, then try to keep the\n"
" monitor in a powered off state. This is to prevent\n"
-" nosey people at the physical display from viewing\n"
-" what is on the screen. Be sure lock the screen before\n"
+" nosey people at the physical display from viewing what\n"
+" is on the screen. Be sure to lock the screen before\n"
" disconnecting.\n"
"\n"
" This method is far from bullet proof, e.g. suppose\n"
@@ -3151,7 +3195,11 @@ void print_help(int mode) {
"\n"
"-threads Whether or not to use the threaded libvncserver\n"
"-nothreads algorithm [rfbRunEventLoop] if libpthread is available\n"
-" Default: %s\n"
+" Default: %s. NOTE: The -threads mode is now\n"
+" disabled due to its unstable behavior. Not recommended,\n"
+" but you can recompile with -DX11VNC_THREADED in\n"
+" CPPFLAGS if you need to use it. You can also set the\n"
+" env. variable X11VNC_THREADED=1\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"