Lines Matching full:x11vnc
5 This file is part of x11vnc.
7 x11vnc is free software; you can redistribute it and/or modify
12 x11vnc is distributed in the hope that it will be useful,
18 along with x11vnc; if not, write to the Free Software
23 gives permission to link the code of its release of x11vnc with the
35 #include "x11vnc.h"
53 "x11vnc: allow VNC connections to real X11 displays. %s\n"
55 "(type \"x11vnc -opts\" to just list the options.)\n"
62 " x11vnc -display :0\n"
68 "Once x11vnc establishes connections with the X11 server and starts listening\n"
72 "the name of the machine running x11vnc and N is XXXX - 5900, i.e. usually\n"
75 "By default x11vnc will not allow the screen to be shared and it will exit\n"
80 " ssh -t -L 5900:localhost:5900 far-host 'x11vnc -localhost -display :0'\n"
86 "For additional info see: http://www.karlrunge.com/x11vnc/\n"
87 " and http://www.karlrunge.com/x11vnc/faq.html\n"
117 " Use '-auth guess' to have x11vnc use its -findauth\n"
121 " XDM/GDM/KDM: if you are running x11vnc as root and want\n"
123 " X session yet, use: x11vnc -env FD_XDM=1 -auth guess ...\n"
141 " then the x11vnc -gui is used to prompt the user to\n"
150 " NOTE: This x11vnc binary was compiled to have the\n"
155 " NOTE: This x11vnc binary was compiled to have\n"
186 " x11vnc on an IPv6-only system, but may have other uses.\n"
192 " that kill x11vnc just after the user logs into the\n"
199 " Update: as of 0.9.9, x11vnc tries to automatically avoid\n"
222 " X server may help show them. x11vnc may crash if the\n"
227 " to have x11vnc run xwininfo(1) for you and extract\n"
239 " options are required. Run 'x11vnc -appshare -help'\n"
257 " running a separate x11vnc on each part.\n"
312 " in x11vnc unless -overlay is used. Another use of\n"
334 " This mode enables a hack where x11vnc monitors windows\n"
476 "-loop Create an outer loop restarting the x11vnc process\n"
505 " seconds x11vnc exits immediately. If a client is\n"
507 " operating state, x11vnc gives it a few more seconds\n"
514 " x11vnc will exit immediately.\n"
539 " specified and you run x11vnc as root for, say, inetd\n"
553 " specified and you run x11vnc as root for, say, inetd\n"
565 " where the Java vncviewer applet is, have x11vnc try\n"
568 " (/usr/local/share/x11vnc/classes, etc). Under -ssl or\n"
603 " Note that unlike most vnc servers, x11vnc will require a\n"
608 " your environment before starting x11vnc.\n"
613 " Be careful about the location of this file if x11vnc\n"
656 " Reverse SSL: using -connect in -ssl mode makes x11vnc\n"
658 " than an SSL server. The idea is x11vnc might be\n"
670 " and -loop300,2 to have x11vnc reconnect once to the\n"
672 " to supply -sslonly to avoid x11vnc thinking the delay\n"
678 " IPv6: as of x11vnc 0.9.10 the -connect option should\n"
686 " connections succeed, then x11vnc shuts down immediately\n"
690 " By the way, if you do not want x11vnc to listen on\n"
738 " to be entered in the terminal where x11vnc is running.\n"
752 " IPv6: as of x11vnc 0.9.10 the -proxy option should\n"
769 " x11vnc's on the same display) set the VNC_CONNECT or\n"
788 " IPv6: as of x11vnc 0.9.10 a host can be specified\n"
794 " x11vnc listens on, see the -listen option below.\n"
805 " If you do not want x11vnc to listen on ANY interface\n"
824 " x11vnc -unixsock ~/s/mysock -rfbport 0 ...\n"
927 " command does not exit with 0, then x11vnc terminates\n"
929 " way set X11VNC_MAX_PASSWDS before starting x11vnc.\n"
983 "-unixpw [list] Use Unix username and password authentication. x11vnc\n"
1006 " x11vnc will attempt to be conservative and reject a\n"
1010 " default it is impossible for the user running x11vnc to\n"
1013 " behavior). So the x11vnc login will always *FAIL* for\n"
1017 " start x11vnc as root with the \"-users +nobody\" option\n"
1037 " to come from the same machine x11vnc is running on\n"
1043 " x11vnc it will check if the environment variable\n"
1052 x11vnc:\n"
1057 " data between the vncviewer and x11vnc: perhaps ssh(1)\n"
1071 " x11vnc runs and only local connections from that machine\n"
1077 " to connect to the same machine x11vnc is running on\n"
1086 " Tip: you can also have your own stunnel spawn x11vnc\n"
1120 " This feature enables x11vnc to be a general unix user\n"
1129 " some other means. The exit code of x11vnc will depend\n"
1142 " will be inaccessible unless x11vnc is run as root.\n"
1153 " On the other hand, when x11vnc is run as root it will\n"
1156 " running x11vnc from inetd and xdm/gdm/kdm).\n"
1160 " can run x11vnc as root and use -unixpw_nis. Any users\n"
1163 " In -unixpw_nis mode, under no circumstances is x11vnc's\n"
1168 " and -create -display WAIT:... modes then, if x11vnc is\n"
1200 " # Example x11vnc -unixpw_cmd script.\n"
1228 " In -unixpw_cmd mode, under no circumstances is x11vnc's\n"
1251 " have access rights to). x11vnc then exits.\n"
1257 " and failing that \":0\" is used. x11vnc then exits.\n"
1265 " XDM/GDM/KDM: if you are running x11vnc as root and want\n"
1267 " X session yet, use: x11vnc -env FD_XDM=1 -findauth ...\n"
1362 " Example: x11vnc -xdmsvc -unixpw_system_greeter\n"
1407 " x11vnc waits until a VNC client connects before opening\n"
1411 " for certain usage modes (say if x11vnc is started at\n"
1449 " In the case of -unixpw (and -unixpw_nis only if x11vnc\n"
1519 " variable X11VNC_NO_UNIXPW_OPTS=1 before starting x11vnc.\n"
1521 " (x11vnc -gui connect) or the remote control method\n"
1522 " (x11vnc -R opt:val) during his VNC session.\n"
1533 " (it automatically forks a new x11vnc for each user).\n"
1534 " You can have the x11vnc inetd spawned process run as,\n"
1537 " \"-users unixpw=\" to have the x11vnc process switch to\n"
1561 " www.karlrunge.com/x11vnc/faq.html#faq-display-manager\n"
1566 " e.g. 'x11vnc -env FD_XDM=1 -find ...' and x11vnc is\n"
1572 " x11vnc to service one http request and then exit.\n"
1577 " 5815 stream tcp nowait root /usr/sbin/tcpd /.../x11vnc \\\n"
1578 " -inetd -q -http_ssl -prog /.../x11vnc \\\n"
1581 " Where /.../x11vnc is the full path to x11vnc.\n"
1604 " for the user. This is the only time x11vnc tries to\n"
1623 " The Xdummy wrapper is part of the x11vnc source code\n"
1624 " (x11vnc/misc/Xdummy) It should be available in PATH\n"
1639 " When x11vnc exits (i.e. user disconnects) the X\n"
1650 " So this is a somewhat odd mode for x11vnc in that it\n"
1656 " 5900 stream tcp nowait root /usr/sbin/tcpd /.../x11vnc\n"
1658 " -passwd secret -prog /.../x11vnc \\\n"
1661 " Where /.../x11vnc is the full path to x11vnc.\n"
1665 " If for some reason you do not want x11vnc to ever\n"
1728 " If you set the env. var WAITBG=1 x11vnc will go into\n"
1737 " So in Xvnc.redirect x11vnc does no VNC but merely\n"
1739 " faster then x11vnc's polling method, but not as fast\n"
1741 " The idea here is to take advantage of x11vnc's display\n"
1743 " Most of x11vnc's options do not apply in this mode.\n"
1761 " supported. x11vnc's normal SSL mode (vncs://) will be\n"
1812 " x11vnc's normal SSL mode (vncs://) will be supported\n"
1852 " and x11vnc. This requires libssl support to be\n"
1853 " compiled into x11vnc at build time. If x11vnc is not\n"
1861 " http://www.karlrunge.com/x11vnc/faq.html#faq-ssl-tun\n"
1862 " nel-viewers . x11vnc provides an SSL enabled Java\n"
1914 " Examples: x11vnc -ssl SAVE -display :0 ...\n"
1915 " x11vnc -ssl SAVE-someother -display :0 ...\n"
1921 " certificate x11vnc exits immediately. The temporary\n"
1922 " cert will be discarded when x11vnc exits.\n"
1952 " If your x11vnc binary was not compiled with OpenSSL\n"
1958 " the env. var. X11VNC_SHOW_TMP_PEM=1 to have x11vnc print\n"
1975 " scripting SSL connections (e.g. x11vnc is started via\n"
1976 " ssh) and you do not want x11vnc waiting around for more\n"
1985 " the simplest case, \"-ssl SAVE\" will store the x11vnc\n"
1993 " -ssldir /var/lib/x11vnc-certs).\n"
2012 " x11vnc -ssl -sslverify ~/my.crt\n"
2013 " x11vnc -ssl -sslverify ~/my_pem_dir/\n"
2048 " x11vnc -ssl -sslverify CA\n"
2049 " x11vnc -ssl -sslverify self:fred,self:jim\n"
2050 " x11vnc -ssl -sslverify CA,clients\n"
2065 " VNC-ing with x11vnc. (note that they require openssl(1)\n"
2069 " x11vnc automatically generates its own, self-signed,\n"
2076 " \"-ssl\", i.e. the default) to have x11vnc create a\n"
2094 " that then x11vnc would use to authenticate itself to\n"
2098 " VNC clients themselves are authenticated to x11vnc\n"
2102 " x11vnc will be able to use all of these cert and\n"
2128 " Only rarely will one's x11vnc -ssl infrastructure be so\n"
2132 " x11vnc with a Certificate Authority (see -sslGenCA)\n"
2145 " x11vnc then exits.\n"
2156 " x11vnc command exits; the VNC server is not run.\n"
2173 " x11vnc -sslGenCA\n"
2174 " x11vnc -sslGenCA ~/myCAdir\n"
2175 " x11vnc -ssldir ~/myCAdir -sslGenCA\n"
2184 " After the Certificate is generated x11vnc exits; the\n"
2188 " It is either \"server\" (i.e. for use by x11vnc) or\n"
2219 " pick up the x11vnc PEM file this option generates.\n"
2253 " The \"server\" certs can be used by x11vnc directly by\n"
2273 " masquerade as the x11vnc server (or VNC viewer client).\n"
2277 " be typed in EVERY time x11vnc or the client app is\n"
2282 " x11vnc -sslGenCert server\n"
2283 " x11vnc -ssl SAVE -display :0 ...\n"
2296 " x11vnc -sslGenCert server charlie\n"
2297 " x11vnc -ssl SAVE-charlie -display :0 ...\n"
2301 " x11vnc -sslGenCert client roger\n"
2305 " x11vnc is then started with the option -sslverify\n"
2319 " used (e.g. by x11vnc) the passphrase must be supplied\n"
2328 " the x11vnc command exits; the VNC server is not run.\n"
2331 " x11vnc -sslEncKey /path/to/foo.pem\n"
2332 " x11vnc -sslEncKey SAVE\n"
2333 " x11vnc -sslEncKey SAVE-charlie\n"
2340 " After the info is printed the x11vnc command exits;\n"
2360 " having to concatenate them. x11vnc will not use them\n"
2368 " associated with [pem]. x11vnc then exits. \"SAVE\"\n"
2371 "-sslScripts Prints out both the 'genCA' and 'genCert' x11vnc\n"
2373 " The scripts are printed to stdout and then the x11vnc\n"
2378 " encrypted SSL tunnel between viewers and x11vnc.\n"
2407 " stunnel is started up as a child process of x11vnc and\n"
2409 " sent to x11vnc over a local socket. The strings\n"
2432 " The x11vnc project's SSVNC is an option.\n"
2434 " Also, in the x11vnc distribution, patched TightVNC\n"
2449 " %% x11vnc -stunnel -http_ssl -http_oneport ...\n"
2544 " where h:p is the hostname and port of the x11vnc server.\n"
2563 " VncViewer.jar applet that is provided with x11vnc).\n"
2581 " more reliable HTTPS port that x11vnc will listen on. If\n"
2599 " from one port to an internal machine where x11vnc is\n"
2611 " \"-httpsredir\" to x11vnc.\n"
2618 " E.g. x11vnc -env X11VNC_EXTRA_HTTPS_PARAMS='?GET=1' ...\n"
2665 " method. lport will be the local x11vnc listening port,\n"
2667 " will reach x11vnc. E.g. fred@snoopy.com:0\n"
2670 " incoming connections to the x11vnc machine, but\n"
2689 " to be entered in the terminal where x11vnc is running.\n"
2699 " x11vnc exits. It tries by looking at ps(1) output.\n"
2706 " the -rfbauth option. If none of these succeed x11vnc\n"
2713 " If called with no arguments, \"x11vnc -storepasswd\",\n"
2718 "-nopw Disable the big warning message when you use x11vnc\n"
2731 " If x11vnc is running as root (say from inetd(8) or from\n"
2739 " RFB_SERVER_IP and RFB_SERVER_PORT (the x11vnc side\n"
2741 " of the tcp virtual circuit. The x11vnc process\n"
2784 " Note that x11vnc blocks while the external command\n"
2788 " a 2nd x11vnc if you lock yourself out).\n"
2802 " command return code is not interpreted by x11vnc.\n"
2809 " interpreted by x11vnc. Example: -gone 'xlock &'\n"
2811 "-users list If x11vnc is started as root (say from inetd(8) or from\n"
2815 " comma separated \"list\". If x11vnc is not running as\n"
2819 " x11vnc is already connected to the X display and can\n"
2821 " to make some of the *external* utility commands x11vnc\n"
2843 " get the x11vnc process to switch to user \"fred\".\n"
2872 " -unixpw mechanism, x11vnc will try to switch to that\n"
2880 " cert (the -sslverify option is required for this) x11vnc\n"
2890 " NOTE: for sslpeer= mode the x11vnc administrator must\n"
2960 " If x11vnc is running as root (inetd(8) or gdm(1)),\n"
2962 " If x11vnc guesses your desktop incorrectly, you can\n"
2998 " to occur to the display while x11vnc is running, this\n"
2999 " options indicates x11vnc should try to respond to\n"
3028 " x11vnc.\n"
3083 " useful by wrapper script to detect when x11vnc is ready.\n"
3085 "-rmflag file Remove \"file\" at exit to signal when x11vnc is done.\n"
3088 " If the file is created, the x11vnc PID is placed in\n"
3096 " at x11vnc startup. This is a convenience utility to\n"
3100 "-prog /path/to/x11vnc Set the full path to the x11vnc program for cases when\n"
3104 "-?, -opts Only list the x11vnc options.\n"
3125 " port=`ssh -t $host \"x11vnc -display :0 -bg\" | grep PORT`\n"
3175 " machine and the x11vnc X server are in the CapsLock\n"
3187 "-skip_lockkeys Have x11vnc ignore all Caps_Lock, Shift_Lock, Num_Lock,\n"
3190 " not change the lock state in the x11vnc-side X server.\n"
3192 " the wire and are applied correctly to the x11vnc-side\n"
3202 " to -xkb mode. Use this option to help x11vnc in the\n"
3227 " also when x11vnc exits. Default: %s\n"
3259 " quickly this way (especially if x11vnc scroll detection\n"
3429 " Starting with x11vnc 0.9.9 it tries to automatically\n"
3481 " have problems with x11vnc's original mouse input\n"
3482 " injection method. So x11vnc's mouse input injection\n"
3484 " use this option: -always_inject. Then x11vnc will\n"
3492 " Window' was activated. This was because x11vnc injected\n"
3496 " So now by default x11vnc tries to avoid injecting the\n"
3499 " Note that with the new default x11vnc will be oblivious\n"
3513 " but the x11vnc side does not, these will do scrolls:\n"
3534 " prevent x11vnc from crashing if the X server reports\n"
3569 " both on the x11vnc server side and on the VNC Viewer\n"
3571 " tripled for both x11vnc and the VNC Viewer. As a rule\n"
3964 " a window manager that does this. x11vnc takes care to\n"
3965 " avoid the problem, but if caught x11vnc will freeze.\n"
3969 " manager if that is feasible. With -grab_buster, x11vnc\n"
3970 " will fork a helper thread and if x11vnc appears to be\n"
3986 " Neither x11vnc's screen polling and vnc compression\n"
4029 " example \"x11vnc -R pm:4\" or the tcl/tk gui (Tuning ->\n"
4037 "-allinput Have x11vnc read and process all available client input\n"
4043 "-speeds rd,bw,lat x11vnc tries to estimate some speed parameters that\n"
4068 " x11vnc has to work around issues for certain window\n"
4109 " text output. By default x11vnc will try to detect this\n"
4146 " for monitors). This interferes with x11vnc's polling\n"
4162 " (usually x11vnc has no problem exporting the display in\n"
4185 " machine so that there is a gap of time before x11vnc\n"
4197 " cause the server (x11vnc) to try to disable keyboard\n"
4207 " that x11vnc is polling. That way the person on the VNC\n"
4212 " later) MUST BE installed on the system where x11vnc runs\n"
4215 " See http://www.karlrunge.com/x11vnc/ssvnc.html\n"
4229 " x11vnc's use of the DAMAGE extension: 1) significantly\n"
4259 " for \"exit\" x11vnc will cleanup and exit at the 1st\n"
4267 " You can also put \"exit:..\" in the list to have x11vnc\n"
4366 " the memory object. If the masks are not provided x11vnc\n"
4397 " changing them in a running x11vnc.\n"
4399 " If you DO NOT want x11vnc to close the X DISPLAY in\n"
4415 " If you want x11vnc to dynamically transform a 24bpp\n"
4436 " to export them via x11vnc can often be thwarted due to\n"
4445 " parameters x11vnc will try to determine them. It first\n"
4470 " e.g. xawtv, spcaview, and hope they persist when x11vnc\n"
4502 " x11vnc. See the -freqtab option below to supply one\n"
4536 " x11vnc if you replace \"console\" with \"vt\" in the\n"
4567 " not graphics. x11vnc polls the text in /dev/vcsaN\n"
4605 " If you do not want x11vnc to guess the framebuffer's\n"
4621 " VNC server \"host\" is connected to (i.e. x11vnc acts as\n"
4631 " x11vnc on the fast side of the link, and so avoided\n"
4653 " is x11vnc doing wireframing, or an X display that does\n"
4663 " To set the pixel format that x11vnc requests as a VNC\n"
4684 " \"cmd\" that x11vnc will pipe all of the user input\n"
4686 " default x11vnc will not process any of the user input\n"
4698 " to use if it wants. Do 'env | grep X11VNC' for more.\n"
4751 " application cursor moves (x11vnc has no control over,\n"
4787 " acceleration. If x11vnc has trouble deducing the\n"
4909 " is to start up both the full gui and x11vnc with the\n"
4921 " \"conn\" means do not automatically start up x11vnc,\n"
4922 " but instead just try to connect to an existing x11vnc\n"
4924 " else (you will later instruct the gui to start x11vnc\n"
4935 " two different X displays: x11vnc polls one, but you\n"
4937 " you ssh in and x11vnc is not running yet you may want\n"
4943 " option are tried (in that order). Regarding the x11vnc\n"
4946 " \"x11vnc -display :0 -gui otherhost:0\", will remote\n"
4947 " control an x11vnc polling :0 and display the gui on\n"
4949 " preference, preferring to display on the x11vnc display.\n"
4962 " x11vnc option (if the x11vnc server is started along\n"
4964 " been specified. So x11vnc (and the tray/icon gui)\n"
4998 " General examples of the -gui option: \"x11vnc -gui\",\n"
4999 " \"x11vnc -gui ez\" \"x11vnc -gui localhost:10\",\n"
5000 " \"x11vnc -gui conn,host:0\", \"x11vnc -gui tray,ez\"\n"
5001 " \"x11vnc -gui tray=setpass\"\n"
5003 " If you do not intend to start x11vnc from the gui\n"
5006 " x11vnc server as long as X permissions, etc. permit\n"
5029 " specify them on the x11vnc command line.\n"
5032 " x11vnc server. \"-R\" and \"-r\" are aliases for\n"
5034 " sent to the running server the 'x11vnc -remote ...'\n"
5035 " x11vnc command exits. You can often use the -query\n"
5036 " command (see below) to see if the x11vnc server\n"
5049 " For example: 'x11vnc -remote stop' (which is the same as\n"
5050 " 'x11vnc -R stop') will close down the x11vnc server.\n"
5051 " 'x11vnc -R shared' will enable shared connections, and\n"
5052 " 'x11vnc -R scale:3/4' will rescale the desktop.\n"
5056 " x11vnc's on the same display) set the X11VNC_REMOTE\n"
5062 " like: x11vnc -R 'script:firstcmd;secondcmd;...'\n"
5064 " Use x11vnc -R script:file=/path/to/file to read commands\n"
5069 " To not try to contact another x11vnc process and instead\n"
5077 " ping see if the x11vnc server responds.\n"
5249 " keystate have x11vnc print current keystate.\n"
5372 " mouse_x print x11vnc's idea of cursor position.\n"
5373 " mouse_y print x11vnc's idea of cursor position.\n"
5487 " What the x11vnc bcx_xattach command does is to perform\n"
5495 " has been crossed. Note that the x11vnc executing the\n"
5502 " by xattach/x2x. x11vnc can use this info to verify that\n"
5574 " running x11vnc server then that file can be used as a\n"
5576 " control one of many x11vnc's polling the same X display)\n"
5577 " Simply run: 'x11vnc -connect /path/to/file -remote ...'\n"
5687 " value for that parameter (no running x11vnc server\n"
5693 " acknowledgement from the x11vnc server that command was\n"
5705 " (see the next paragraph) so if the x11vnc takes longer\n"
5714 "-query_retries str If a query fails to get a response from an x11vnc\n"
5735 " sent via 'x11vnc -remote ...'. If it begins with\n"
5743 " VNC viewers to run x11vnc -remote commands. Do not\n"
5753 " control x11vnc. Normally access to the X display is\n"
5756 " run their own x11vnc and thus have complete control\n"
5759 " to /path/to/file can remotely control x11vnc. So be\n"
5817 fprintf(stderr, "x11vnc: allow VNC connections to real "
5894 fprintf(stderr, "*** x11vnc was unable to open the X DISPLAY: \"%s\","
5902 " be running before x11vnc is\n");
5903 fprintf(stderr, " started: x11vnc does not start the X server. "
5912 " x11vnc uses this if you forget\n");
5924 fprintf(stderr, " - Often, you just need to run x11vnc as the user"
5927 " x11vnc.\n");
5932 fprintf(stderr, " allows x11vnc to connect to the desired"
5937 fprintf(stderr, " x11vnc -auth /home/someuser/.Xauthority"
5939 fprintf(stderr, " x11vnc -auth /tmp/.gdmzndVlR"
5962 fprintf(stderr, " Starting with x11vnc 0.9.9 you can have it try to guess by using:\n");
5966 fprintf(stderr, " (see also the x11vnc -findauth option.)\n");
5969 " file, and so x11vnc must be run\n");
5975 fprintf(stderr, "See also: http://www.karlrunge.com/x11vnc/faq.html\n");
5986 "#@ YOU ARE RUNNING X11VNC WITHOUT A PASSWORD!! @#\n"
5997 "#@ You can create an x11vnc password file by running: @#\n"
5999 "#@ x11vnc -storepasswd password /path/to/passfile @#\n"
6000 "#@ or x11vnc -storepasswd /path/to/passfile @#\n"
6001 "#@ or x11vnc -storepasswd @#\n"
6005 "#@ and then starting x11vnc via: @#\n"
6007 "#@ x11vnc -rfbauth /path/to/passfile @#\n"
6018 "#@ Use x11vnc -usepw to automatically use your @#\n"
6021 "#@ file exists.) Under -usepw, x11vnc will exit if it @#\n"
6028 "#@ http://www.karlrunge.com/x11vnc/#tunnelling @#\n"
6030 "#@ Or using the x11vnc SSL options: -ssl and -stunnel @#\n"
6035 "#@ http://www.karlrunge.com/x11vnc/faq.html#faq-passwd @#\n"
6435 "x11vnc: a VNC server for X displays. %s\n"
