diff options
Diffstat (limited to 'x11vnc/help.c')
| -rw-r--r-- | x11vnc/help.c | 90 |
1 files changed, 72 insertions, 18 deletions
diff --git a/x11vnc/help.c b/x11vnc/help.c index 5183029..c83e161 100644 --- a/x11vnc/help.c +++ b/x11vnc/help.c @@ -762,29 +762,61 @@ void print_help(int mode) { " in addition to this option.\n" "\n" #endif -"-find Find the user's display using FINDDISPLAY. It is\n" -" an alias for \"-display WAIT:cmd=FINDDISPLAY\".\n" -" Use -finddpy to run the FINDDISPLAY program and exit.\n" +"-find Find the user's display using FINDDISPLAY. This is an\n" +" alias for \"-display WAIT:cmd=FINDDISPLAY\".\n" +"\n" +" For this and the next few options see -display WAIT:...\n" +" below for all of the details.\n" +"\n" +"-finddpy Run the FINDDISPLAY program, print out the found\n" +" display (if any) and exit. Output is like: DISPLAY=:0.0\n" +" DISPLAY=:0.0,XPID=12345 or DISPLAY=:0.0,VT=7. XPID is\n" +" the process ID of the found X server. VT is the Linux\n" +" virtual terminal of the X server.\n" +"-listdpy Have the FINDDISPLAY program list all of your displays\n" +" (i.e. all the X displays on the local machine that you\n" +" have access rights to).\n" "\n" "-create First try to find the user's display using FINDDISPLAY,\n" -" if that doesn't work create an X session via the\n" -" FINDCREATEDISPLAY method. This is an alias for\n" +" if that doesn't succeed create an X session via the\n" +" FINDCREATEDISPLAY method. This is an alias for\n" " \"-display WAIT:cmd=FINDCREATEDISPLAY-Xvfb\".\n" "\n" -"-xdummy As -create except Xdummy instead of Xvfb. Implies\n" +"-xdummy As in -create, except Xdummy instead of Xvfb. Implies\n" " FD_XDUMMY_NOROOT=1.\n" +"-xvnc As in -create, except Xvnc instead of Xvfb.\n" +"-xvnc_redirect As in -create, except Xvnc.redirect instead of Xvfb.\n" "\n" "-svc Terminal services mode. Also \"-service\". Alias for\n" " -display WAIT:cmd=FINDCREATEDISPLAY-Xvfb -unixpw\n" " -users unixpw= -ssl SAVE\n" "\n" -"-svc_xdummy As -svc except Xdummy instead of Xvfb. Implies\n" -" FD_XDUMMY_NOROOT=1.\n" +"-svc_xdummy As -svc except Xdummy instead of Xvfb. Implies\n" +" FD_XDUMMY_NOROOT=1.\n" +"-svc_xvnc As -svc except Xvnc instead of Xvfb.\n" "\n" "-xdmsvc Terminal services mode. Also \"-xdm_service\". Alias for\n" " -display WAIT:cmd=FINDCREATEDISPLAY-Xvfb.xdmcp -unixpw\n" " -users unixpw= -ssl SAVE\n" "\n" +"-redirect port As in FINDCREATEDISPLAY-Xvnc.redirect mode except\n" +" redirect immediately (i.e. without X session finding\n" +" or creation) to a VNC server listening on port. You\n" +" can also supply host:port to redirect to a different\n" +" machine.\n" +"\n" +" If 0 <= port < 200 it is taken as a VNC display (5900 is\n" +" added to get the actual port), if port < 0 then -port\n" +" is used.\n" +"\n" +" Probably the only reason to use the -redirect option is\n" +" in conjunction with SSL support, e.g. -ssl, -ssl SAVE.\n" +" This provides an easy way to add SSL encryption to a VNC\n" +" server that does not support SSL (e.g. Xvnc or vnc.so)\n" +" In fact, the protocol does not even need to be VNC,\n" +" and so \"-ssl SAVE -redirect host:port\" can act as a\n" +" replacement for stunnel(1).\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" @@ -845,15 +877,16 @@ void print_help(int mode) { " your long \"login:\" line press the Up arrow once\n" " (before typing anything else).\n" "\n" -" Another option is \"geom=WxH\" or \"geom=WxHxD\" (or\n" -" ge=). This only has an effect in FINDCREATEDISPLAY\n" -" mode when a virtual X server such as Xvfb is going\n" -" to be created. It sets the width and height of\n" -" the new display, and optionally the color depth as\n" -" well. You can also supply \"gnome\", \"kde\", \"twm\",\n" -" \"fvwm\", \"mwm\", \"dtwm\", \"wmaker\", \"Xsession\",\n" -" or \"failsafe\" (same as \"xterm\") to have the created\n" -" display use that mode for the user session.\n" +" Another option is \"geom=WxH\" or \"geom=WxHxD\"\n" +" (or ge=). This only has an effect in FINDCREATEDISPLAY\n" +" mode when a virtual X server such as Xvfb is going to\n" +" be created. It sets the width and height of the new\n" +" display, and optionally the color depth as well. You\n" +" can also supply \"gnome\", \"kde\", \"twm\", \"fvwm\",\n" +" \"mwm\", \"dtwm\", \"wmaker\", \"enlightenment\",\n" +" \"Xsession\", or \"failsafe\" (same as \"xterm\")\n" +" to have the created display use that mode for the\n" +" user session.\n" "\n" " To disable the option setting set the environment\n" " variable X11VNC_NO_UNIXPW_OPTS=1 before starting x11vnc.\n" @@ -885,7 +918,9 @@ void print_help(int mode) { " DISPLAY variable and xauthority data (see who(1)).\n" "\n" " To have this default script printed to stdout (e.g. for\n" -" customization) run with WAIT:cmd=FINDDISPLAY-print\n" +" customization) run with WAIT:cmd=FINDDISPLAY-print To\n" +" have the script run to print what display it would find\n" +" use \"-finddpy\" or WAIT:cmd=FINDDISPLAY-run\n" "\n" " As another special case, WAIT:cmd=HTTPONCE will allow\n" " x11vnc to service one http request and then exit.\n" @@ -998,6 +1033,25 @@ void print_help(int mode) { " If you set the env. var WAITBG=1 x11vnc will go into\n" " the background once listening in wait mode.\n" "\n" +" Another special mode is FINDCREATEDISPLAY-Xvnc.redirect,\n" +" (or FINDDISPLAY-Xvnc.redirect). In this case it will\n" +" start up Xvnc as above if needed, but instead of\n" +" polling it in its normal way, it simply does a socket\n" +" redirection of the connected VNC viewer to the Xvnc.\n" +"\n" +" So in Xvnc.redirect x11vnc does no VNC but merely\n" +" transfers the data back and forth. This should be\n" +" faster then x11vnc's polling method, but not as fast\n" +" as connecting directly to the Xvnc with the VNC Viewer.\n" +" The idea here is to take advantage of x11vnc's display\n" +" finding/creating scheme, SSL, and perhaps a few others.\n" +" Most of x11vnc's options do not apply in this mode.\n" +"\n" +" Xvnc.redirect should also work for the vnc.so X server\n" +" module for the h/w display however it will work only\n" +" for finding the display and the user must already be\n" +" logged into the X console.\n" +"\n" #ifndef NO_SSL_OR_UNIXPW "-nossl Disable the -ssl option (see below). Since -ssl is off\n" " by default -nossl would only be used on the commandline\n" |