summaryrefslogtreecommitdiffstats
path: root/x11vnc/help.c
diff options
context:
space:
mode:
authorrunge <runge>2007-02-12 02:42:28 +0000
committerrunge <runge>2007-02-12 02:42:28 +0000
commit0016cd4280ee9a0d088454a508a9c7f6bde33f62 (patch)
tree41614a1dfbd8bba02f35a588e8cc87d4e7692173 /x11vnc/help.c
parent90d96b971f04b11fe1902091a94be94697738766 (diff)
downloadlibtdevnc-0016cd4280ee9a0d088454a508a9c7f6bde33f62.tar.gz
libtdevnc-0016cd4280ee9a0d088454a508a9c7f6bde33f62.zip
x11vnc: -grabalways, -forcedpms, -clientdpms, -noserverdpms, -loopbg, -svc, -xdmsvc
Diffstat (limited to 'x11vnc/help.c')
-rw-r--r--x11vnc/help.c165
1 files changed, 120 insertions, 45 deletions
diff --git a/x11vnc/help.c b/x11vnc/help.c
index d7b2ebc..8d60c93 100644
--- a/x11vnc/help.c
+++ b/x11vnc/help.c
@@ -306,14 +306,32 @@ void print_help(int mode) {
" disconnects, opposite of -forever. This is the Default.\n"
"-forever Keep listening for more connections rather than exiting\n"
" as soon as the first client(s) disconnect. Same as -many\n"
+"\n"
"-loop Create an outer loop restarting the x11vnc process\n"
-" whenever it terminates. -bg and -inetd are ignored in\n"
-" this mode. Useful for continuing even if the X server\n"
-" terminates and restarts (you will need permission to\n"
-" reconnect of course). Use, e.g., -loop100 to sleep\n"
-" 100 millisecs between restarts, etc. Default is 2000ms\n"
-" (i.e. 2 secs) Use, e.g. -loop300,5 to sleep 300 ms\n"
-" and only loop 5 times.\n"
+" whenever it terminates. -bg and -inetd are ignored\n"
+" in this mode (however see -loopbg below).\n"
+"\n"
+" Useful for continuing even if the X server terminates\n"
+" and restarts (at that moment the process will need\n"
+" permission to reconnect to the new X server of course).\n"
+"\n"
+" Use, e.g., -loop100 to sleep 100 millisecs between\n"
+" restarts, etc. Default is 2000ms (i.e. 2 secs) Use,\n"
+" e.g. -loop300,5 to sleep 300 ms and only loop 5 times.\n"
+"\n"
+" If -loopbg (plus any numbers) is specified instead,\n"
+" the \"-bg\" option is implied and the mode approximates\n"
+" inetd(8) usage to some degree. In this case when\n"
+" it goes into the background any listening sockets\n"
+" (i.e. ports 5900, 5800) are closed, so the next one\n"
+" in the loop can use them. This mode will only be of\n"
+" use if a VNC client (the only client for that process)\n"
+" is already connected before the process goes into the\n"
+" background, for example, usage of -display WAIT:..,\n"
+" -svc, and -connect can make use of this \"poor man's\"\n"
+" inetd mode. The default wait time is 500ms in this\n"
+" mode. This usage could use useful: -svc -loopbg\n"
+"\n"
"-timeout n Exit unless a client connects within the first n seconds\n"
" after startup.\n"
"-inetd Launched by inetd(8): stdio instead of listening socket.\n"
@@ -445,6 +463,11 @@ void print_help(int mode) {
" act on the local user's input. Again, some degree of\n"
" cooperation from the person at the display is assumed.\n"
"\n"
+"-grabalways Apply both -grabkbd and -grabptr even when no VNC\n"
+" viewers are connected. If you only want one of them,\n"
+" use the -R remote control to turn the other back on,\n"
+" e.g. -R nograbptr.\n"
+"\n"
"-viewpasswd string Supply a 2nd password for view-only logins. The -passwd\n"
" (full-access) password must also be supplied.\n"
"\n"
@@ -688,6 +711,14 @@ void print_help(int mode) {
" in addition to this option.\n"
"\n"
#endif
+"-svc Terminal services mode. Also \"-service\", implies\n"
+" -display WAIT:cmd=FINDCREATEDISPLAY-Xvfb -unixpw\n"
+" -users unixpw= -ssl SAVE\n"
+"\n"
+"-xdmsvc Terminal services mode. Also \"-xdm_service\", implies\n"
+" -display WAIT:cmd=FINDCREATEDISPLAY-Xvfb.xdmcp -unixpw\n"
+" -users unixpw= -ssl SAVE\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"
@@ -792,7 +823,7 @@ void print_help(int mode) {
" Where /.../x11vnc is the full path to x11vnc.\n"
" It is used in the Apache SSL-portal example (see FAQ).\n"
"\n"
-" An experimental option is WAIT:cmd=FINDCREATEDISPLAY\n"
+" An interesting option is WAIT:cmd=FINDCREATEDISPLAY\n"
" that is like FINDDISPLAY in that is uses the same method\n"
" to find an existing display. However, if it does not\n"
" find one it will try to *start* up an X server session\n"
@@ -807,11 +838,12 @@ void print_help(int mode) {
" and only works on Linux. Xvfb is available on most\n"
" platforms and does not require root.\n"
"\n"
-" When x11vnc exits (i.e. user disconnects) the X server\n"
-" session stays running in the background. Presumably\n"
-" the FINDDISPLAY will find it next time. The user must\n"
-" exit the X session in the usual way for it to terminate\n"
-" (or kill the X server process if all else fails).\n"
+" When x11vnc exits (i.e. user disconnects) the X\n"
+" server session stays running in the background.\n"
+" The FINDDISPLAY will find it directly next time.\n"
+" The user must exit the X session in the usual way for\n"
+" it to terminate (or kill the X server process if all\n"
+" else fails).\n"
"\n"
" So this is a somewhat odd mode for x11vnc in that it\n"
" will start up and poll virtual X servers! This can\n"
@@ -848,7 +880,14 @@ void print_help(int mode) {
" for kdm in kdmrc: Enable=true in section [Xdmcp]\n"
" for xdm in xdm-config: DisplayManager.requestPort: 177\n"
"\n"
+" See the shorthand options above \"-svc\" and \"-xdmsvc\"\n"
+" that specify the above options for some useful cases.\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"
+" to unset any *earlier* -ssl option (or -svc...)\n"
+"\n"
"-ssl [pem] Use the openssl library (www.openssl.org) to provide a\n"
" built-in encrypted SSL tunnel between VNC viewers and\n"
" x11vnc. This requires libssl support to be compiled\n"
@@ -2649,6 +2688,32 @@ void print_help(int mode) {
" for details. -nodpms is basically the same as running\n"
" \"xset dpms force on\" periodically. Default: %s\n"
"\n"
+"-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"
+" disconnecting.\n"
+"\n"
+" This method is far from bullet proof, e.g. suppose\n"
+" someone attaches a non-DPMS monitor, or loads the\n"
+" machine so that there is a gap of time before x11vnc\n"
+" restores the powered off state? On many machines if\n"
+" he floods it with keyboard and mouse input he can see\n"
+" flashes of what is on the screen before the DPMS off\n"
+" state is reestablished. For this to work securely\n"
+" there would need to be support in the X server to do\n"
+" this exactly rather than approximately with DPMS.\n"
+"\n"
+"-clientdpms As -forcedpms but only when VNC clients are connected.\n"
+"\n"
+"-noserverdpms The UltraVNC ServerInput extension is supported.\n"
+" This allows the VNC viewer to click a button that will\n"
+" cause the server (x11vnc) to try to disable keyboard\n"
+" and mouse input at the physical display and put the\n"
+" monitor in dpms powered off state. Use this option to\n"
+" skip powering off the monitor.\n"
+"\n"
"-noxdamage Do not use the X DAMAGE extension to detect framebuffer\n"
" changes even if it is available. Use -xdamage if your\n"
" default is to have it off.\n"
@@ -3339,6 +3404,8 @@ void print_help(int mode) {
" nograbkbd disable -grabkbd mode.\n"
" grabptr enable -grabptr mode.\n"
" nograbptr disable -grabptr mode.\n"
+" grabalways enable -grabalways mode.\n"
+" nograbalways disable -grabalways mode.\n"
" client_input:str set the K, M, B -input on a per-client\n"
" basis. select which client as for\n"
" disconnect, e.g. client_input:host:MB\n"
@@ -3503,6 +3570,12 @@ void print_help(int mode) {
" nofbpm enable -nofbpm mode.\n"
" dpms disable -nodpms mode.\n"
" nodpms enable -nodpms mode.\n"
+" forcedpms enable -forcedpms mode.\n"
+" noforcedpms disable -forcedpms mode.\n"
+" clientdpms enable -clientdpms mode.\n"
+" noclientdpms disable -clientdpms mode.\n"
+" noserverdpms enable -noserverdpms mode.\n"
+" serverdpms disable -noserverdpms mode.\n"
" xdamage enable xdamage polling hints.\n"
" noxdamage disable xdamage polling hints.\n"
" xd_area:A set -xd_area max pixel area to \"A\"\n"
@@ -3608,38 +3681,40 @@ void print_help(int mode) {
" listen lookup nolookup accept afteraccept gone shm\n"
" noshm flipbyteorder noflipbyteorder onetile noonetile\n"
" solid_color solid nosolid blackout xinerama noxinerama\n"
-" xtrap noxtrap xrandr noxrandr xrandr_mode rotate\n"
-" padgeom quiet q noquiet modtweak nomodtweak xkb noxkb\n"
-" capslock nocapslock skip_lockkeys noskip_lockkeys\n"
-" skip_keycodes sloppy_keys nosloppy_keys skip_dups\n"
-" noskip_dups add_keysyms noadd_keysyms clear_mods\n"
-" noclear_mods clear_keys noclear_keys remap repeat\n"
-" norepeat fb nofb bell nobell sel nosel primary\n"
-" noprimary setprimary nosetprimary clipboard noclipboard\n"
-" setclipboard nosetclipboard seldir cursorshape\n"
-" nocursorshape cursorpos nocursorpos cursor_drag\n"
-" nocursor_drag cursor show_cursor noshow_cursor\n"
-" nocursor arrow xfixes noxfixes xdamage noxdamage\n"
-" xd_area xd_mem alphacut alphafrac alpharemove\n"
-" noalpharemove alphablend noalphablend xwarppointer\n"
-" xwarp noxwarppointer noxwarp buttonmap dragging\n"
-" nodragging ncache_cr noncache_cr ncache_no_moveraise\n"
-" noncache_no_moveraise ncache_no_dtchange\n"
-" noncache_no_dtchange ncache_no_rootpixmap\n"
-" noncache_no_rootpixmap ncache_reset_rootpixmap\n"
-" ncache_keep_anims noncache_keep_anims ncache noncache\n"
-" ncache_size wireframe_mode wireframe wf nowireframe nowf\n"
-" wireframelocal wfl nowireframelocal nowfl wirecopyrect\n"
-" wcr nowirecopyrect nowcr scr_area scr_skip scr_inc\n"
-" scr_keys scr_term scr_keyrepeat scr_parms scrollcopyrect\n"
-" scr noscrollcopyrect noscr fixscreen noxrecord xrecord\n"
-" reset_record pointer_mode pm input_skip allinput\n"
-" noallinput input grabkbd nograbkbd grabptr nograbptr\n"
-" client_input ssltimeout speeds wmdt debug_pointer dp\n"
-" nodebug_pointer nodp debug_keyboard dk nodebug_keyboard\n"
-" nodk deferupdate defer wait_ui wait_bog nowait_bog\n"
-" slow_fb wait readtimeout nap nonap sb screen_blank\n"
-" fbpm nofbpm dpms nodpms fs gaps grow fuzz snapfb\n"
+" xtrap noxtrap xrandr noxrandr xrandr_mode rotate padgeom\n"
+" quiet q noquiet modtweak nomodtweak xkb noxkb capslock\n"
+" nocapslock skip_lockkeys noskip_lockkeys skip_keycodes\n"
+" sloppy_keys nosloppy_keys skip_dups noskip_dups\n"
+" add_keysyms noadd_keysyms clear_mods noclear_mods\n"
+" clear_keys noclear_keys remap repeat norepeat fb nofb\n"
+" bell nobell sel nosel primary noprimary setprimary\n"
+" nosetprimary clipboard noclipboard setclipboard\n"
+" nosetclipboard seldir cursorshape nocursorshape\n"
+" cursorpos nocursorpos cursor_drag nocursor_drag cursor\n"
+" show_cursor noshow_cursor nocursor arrow xfixes\n"
+" noxfixes xdamage noxdamage xd_area xd_mem alphacut\n"
+" alphafrac alpharemove noalpharemove alphablend\n"
+" noalphablend xwarppointer xwarp noxwarppointer\n"
+" noxwarp buttonmap dragging nodragging ncache_cr\n"
+" noncache_cr ncache_no_moveraise noncache_no_moveraise\n"
+" ncache_no_dtchange noncache_no_dtchange\n"
+" ncache_no_rootpixmap noncache_no_rootpixmap\n"
+" ncache_reset_rootpixmap ncache_keep_anims\n"
+" noncache_keep_anims ncache_old_wm noncache_old_wm\n"
+" ncache 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"
+" scr_parms scrollcopyrect scr noscrollcopyrect noscr\n"
+" fixscreen noxrecord xrecord reset_record pointer_mode pm\n"
+" input_skip allinput noallinput input grabkbd nograbkbd\n"
+" grabptr nograbptr grabalways nograbalways client_input\n"
+" ssltimeout speeds wmdt debug_pointer dp nodebug_pointer\n"
+" nodp debug_keyboard dk nodebug_keyboard nodk deferupdate\n"
+" defer wait_ui wait_bog nowait_bog slow_fb wait\n"
+" readtimeout nap nonap sb screen_blank fbpm nofbpm dpms\n"
+" nodpms clientdpms noclientdpms forcedpms noforcedpms\n"
+" noserverdpms serverdpms fs gaps grow fuzz snapfb\n"
" nosnapfb rawfb uinput_accel uinput_thresh uinput_reset\n"
" uinput_always progressive rfbport http nohttp httpport\n"
" httpdir enablehttpproxy noenablehttpproxy alwaysshared\n"