summaryrefslogtreecommitdiffstats
path: root/x11vnc/help.c
diff options
context:
space:
mode:
Diffstat (limited to 'x11vnc/help.c')
-rw-r--r--x11vnc/help.c84
1 files changed, 52 insertions, 32 deletions
diff --git a/x11vnc/help.c b/x11vnc/help.c
index 55ad36a..c23112c 100644
--- a/x11vnc/help.c
+++ b/x11vnc/help.c
@@ -136,7 +136,7 @@ void print_help(int mode) {
" The default is to start probing at 5900. Use this to\n"
" stay away from other VNC servers near 5900.\n"
"\n"
-"-rfbport str The VNC port to listen on (a libvncserver option), e.g.\n"
+"-rfbport str The VNC port to listen on (a LibVNCServer option), e.g.\n"
" 5900, 5901, etc. If specified as \"-rfbport PROMPT\"\n"
" then the x11vnc -gui is used to prompt the user to\n"
" enter the port number.\n"
@@ -144,20 +144,37 @@ void print_help(int mode) {
#if X11VNC_IPV6
"-6 IPv6 listening support. In addition to IPv4, the\n"
" IPv6 address is listened on for incoming connections.\n"
-" The same port as IPv4 is used to listen. If you have\n"
-" trouble compiling for this mode, set -DX11VNC_IPV6=0\n"
-" in CPPFLAGS when configuring.\n"
+" The same port as IPv4 is used.\n"
"\n"
-" Currently, the machine may need to have some IPv4\n"
-" support, at the least for the loopback interface, for\n"
-" everything to work correctly. However for most usage\n"
-" modes IPv4 support is not required.\n"
+#if X11VNC_LISTEN6
+" NOTE: This x11vnc binary was compiled to have the\n"
+" \"-6\" IPv6 listening mode ENABLED by default (CPPFLAGS\n"
+" -DX11VNC_LISTEN6=1). So to disable IPv6 listening mode\n"
+" you MUST supply the \"-no6\" option (see below.)\n"
+#else
+" NOTE: This x11vnc binary was compiled to have\n"
+" the \"-6\" IPv6 listening mode DISABLED by default\n"
+" (CPPFLAGS -DX11VNC_LISTEN6=0).\n"
+#endif
"\n"
-" The -6 mode works for both normal connections and\n"
+" The \"-6\" mode works for both normal connections and\n"
" -ssl encrypted ones. Nearly everything is supported\n"
" for the IPv6 case, but there are a few exceptions.\n"
" See -stunnel for its IPv6 support.\n"
"\n"
+" Currently, for absolutely everything to work correctly\n"
+" the machine may need to have some IPv4 support, at the\n"
+" least for the loopback interface. However, for nearly\n"
+" all usage modes no IPv4 support is required. See -nopiv4.\n"
+"\n"
+" If you have trouble compiling or running in IPv6 mode,\n"
+" set -DX11VNC_IPV6=0 in CPPFLAGS when configuring to\n"
+" disable IPv6 support.\n"
+"\n"
+"-no6 Disable IPv6 listening support (only useful if the\n"
+" \"-6\" mode is compiled in to be the default; see the\n"
+" X11VNC_LISTEN6 description above under \"-6\".)\n"
+"\n"
"-noipv6 Do not try to use IPv6 for any listening or connecting\n"
" sockets. This includes both the listening service\n"
" port(s) and outgoing connections from -connect,\n"
@@ -522,7 +539,7 @@ void print_help(int mode) {
" Also, tightfilexfer is disabled in -unixpw mode.\n"
"\n"
"-ultrafilexfer Note: to enable UltraVNC filetransfer and to get it to\n"
-" work you probably need to supply these libvncserver\n"
+" work you probably need to supply these LibVNCServer\n"
" options: \"-rfbversion 3.6 -permitfiletransfer\"\n"
" \"-ultrafilexfer\" is an alias for this combination.\n"
"\n"
@@ -635,6 +652,8 @@ void print_help(int mode) {
"-connect_or_exit str As with -connect, except if none of the reverse\n"
" connections succeed, then x11vnc shuts down immediately\n"
"\n"
+" An easier to type alias for this option is '-coe'\n"
+"\n"
" By the way, if you do not want x11vnc to listen on\n"
" ANY interface use -rfbport 0 which is handy for the\n"
" -connect_or_exit mode.\n"
@@ -725,7 +744,7 @@ void print_help(int mode) {
" the comma separated list of hostnames or IP addresses.\n"
" Can also be a numerical IP prefix, e.g. \"192.168.100.\"\n"
" to match a simple subnet, for more control build\n"
-" libvncserver with libwrap support (See the FAQ). If the\n"
+" LibVNCServer with libwrap support (See the FAQ). If the\n"
" list contains a \"/\" it instead is a interpreted\n"
" as a file containing addresses or prefixes that is\n"
" re-read each time a new client connects. Lines can be\n"
@@ -759,10 +778,11 @@ void print_help(int mode) {
" implies the IPv6 loopback address '::1' as well.\n"
"\n"
#if X11VNC_IPV6
-"-listen6 str When in IPv6 listen mode \"-6\", only listen on the\n"
-" network interface with address \"str\". It currently\n"
-" does not work for link scope addresses or non-numeric\n"
-" hostname strings.\n"
+"-listen6 str When in IPv6 listen mode \"-6\", listen only on the\n"
+" network interface with address \"str\". It also works\n"
+" for link scope addresses (fe80::219:dbff:fee5:3f92%%eth0)\n"
+" and IPv6 hostname strings (e.g. ipv6.google.com.)\n"
+" Use LibVNCServer -listen option for the IPv4 interface.\n"
"\n"
#endif
"-nolookup Do not use gethostbyname() or gethostbyaddr() to look up\n"
@@ -822,7 +842,7 @@ void print_help(int mode) {
"-viewpasswd string Supply a 2nd password for view-only logins. The -passwd\n"
" (full-access) password must also be supplied.\n"
"\n"
-"-passwdfile filename Specify the libvncserver password via the first line\n"
+"-passwdfile filename Specify the LibVNCServer password via the first line\n"
" of the file \"filename\" (instead of via -passwd on\n"
" the command line where others might see it via ps(1)).\n"
"\n"
@@ -2499,10 +2519,10 @@ void print_help(int mode) {
" the network (i.e. you just want the single VNC/HTTPS\n"
" port, e.g. 5900, open for connections) then specify the\n"
" option -env X11VNC_HTTP_LISTEN_LOCALHOST=1 This way\n"
-" the connection to the libvncserver httpd server will\n"
+" the connection to the LibVNCServer httpd server will\n"
" only be available on localhost (note that in -ssl mode,\n"
" HTTPS requests are redirected from SSL to the non-SSL\n"
-" libvncserver HTTP server.)\n"
+" LibVNCServer HTTP server.)\n"
"\n"
"-http_oneport For UN-encrypted connections mode (i.e. no -ssl,\n"
" -stunnel, or -enc options), allow the Java VNC Viewer\n"
@@ -2536,7 +2556,7 @@ void print_help(int mode) {
"\n"
" Note that the -env X11VNC_HTTP_LISTEN_LOCALHOST=1\n"
" option described above under -httpsredir applies for\n"
-" the libvncserver httpd server in all cases (ssl or not.)\n"
+" the LibVNCServer httpd server in all cases (ssl or not.)\n"
"\n"
"-ssh user@host:disp Create a remote listening port on machine \"host\"\n"
" via a SSH tunnel using the -R rport:localhost:lport\n"
@@ -2551,7 +2571,7 @@ void print_help(int mode) {
" username differs from the current one.\n"
"\n"
" By default the remote sshd is usually configured to\n"
-" only listen on localhost for rport, so the viewer may\n"
+" listen only on localhost for rport, so the viewer may\n"
" need to ssh -L redir to \"host\" as well (See SSVNC to\n"
" automate this). The sshd setting GatewayPorts enables\n"
" listening on all interfaces for rport; viewers can\n"
@@ -2884,7 +2904,7 @@ void print_help(int mode) {
" where you resize often. It is best to be viewing with a\n"
" vncviewer that supports the NewFBSize encoding, since it\n"
" knows how to react to screen size changes. Otherwise,\n"
-" libvncserver tries to do so something reasonable for\n"
+" LibVNCServer tries to do so something reasonable for\n"
" viewers that cannot do this (portions of the screen\n"
" may be clipped, unused, etc).\n"
"\n"
@@ -3327,7 +3347,7 @@ void print_help(int mode) {
" alpha factor. (useful for light colored semi-transparent\n"
" cursors).\n"
"-noalphablend In XFIXES mode do not send cursor alpha channel data\n"
-" to libvncserver. The default is to send it. The\n"
+" to LibVNCServer. The default is to send it. The\n"
" alphablend effect will only be visible in -nocursorshape\n"
" mode or for clients with cursorshapeupdates turned\n"
" off. (However there is a hack for 32bpp with depth 24,\n"
@@ -3975,9 +3995,9 @@ void print_help(int mode) {
" to really throttle down the screen polls (i.e. sleep\n"
" for about 1.5 secs). Use 0 to disable. Default: %d\n"
"\n"
-"-readtimeout n Set libvncserver rfbMaxClientWait to n seconds. On\n"
+"-readtimeout n Set LibVNCServer rfbMaxClientWait to n seconds. On\n"
" slow links that take a long time to paint the first\n"
-" screen libvncserver may hit the timeout and drop the\n"
+" screen LibVNCServer may hit the timeout and drop the\n"
" connection. Default: %d seconds.\n"
"-ping n Send a 1x1 framebuffer update to all clients every n\n"
" seconds (e.g. to try to keep a network connection alive)\n"
@@ -4046,7 +4066,7 @@ void print_help(int mode) {
" skip powering off the monitor.\n"
"\n"
"-noultraext Disable the following UltraVNC extensions: SingleWindow\n"
-" and ServerInput. The others managed by libvncserver\n"
+" and ServerInput. The others managed by LibVNCServer\n"
" (textchat, 1/n scaling, rfbEncodingUltra) are not.\n"
"\n"
"-chatwindow Place a local UltraVNC chat window on the X11 display\n"
@@ -4100,12 +4120,12 @@ void print_help(int mode) {
" (perhaps useful on a slow machine).\n"
"\n"
"-sigpipe string Broken pipe (SIGPIPE) handling. \"string\" can be\n"
-" \"ignore\" or \"exit\". For \"ignore\" libvncserver\n"
+" \"ignore\" or \"exit\". For \"ignore\" LibVNCServer\n"
" will handle the abrupt loss of a client and continue,\n"
" for \"exit\" x11vnc will cleanup and exit at the 1st\n"
" broken connection.\n"
"\n"
-" This option is not really needed since libvncserver\n"
+" This option is not really needed since LibVNCServer\n"
" is doing the correct thing now for quite some time.\n"
" However, for convenience you can use it to ignore other\n"
" signals, e.g. \"-sigpipe ignore:HUP,INT,TERM\" in case\n"
@@ -4115,7 +4135,7 @@ void print_help(int mode) {
" for this option if you don't like the 'pipe'. Example:\n"
" -sig ignore:INT,TERM,exit:USR1\n"
"\n"
-"-threads Whether or not to use the threaded libvncserver\n"
+"-threads Whether or not to use the threaded LibVNCServer\n"
"-nothreads algorithm [rfbRunEventLoop] if libpthread is available.\n"
" In this mode new threads (one for input and one\n"
" for output) are created to handle each new client.\n"
@@ -4374,7 +4394,7 @@ void print_help(int mode) {
" view and possibly interact with the Linux text/graphics\n"
" console (i.e. not X11 XFree86/Xorg)\n"
"\n"
-" Note: If the libvncserver LinuxVNC program is on your\n"
+" Note: If the LibVNCServer LinuxVNC program is on your\n"
" system you may want to use that instead of the following\n"
" method because it will be faster and more accurate\n"
" for the Linux text console and includes mouse support.\n"
@@ -5158,7 +5178,7 @@ void print_help(int mode) {
" uinput_thresh:n set uinput_thresh to n.\n"
" uinput_reset:n set uinput_reset to n ms.\n"
" uinput_always:n set uinput_always to 1/0.\n"
-" progressive:n set libvncserver -progressive slice\n"
+" progressive:n set LibVNCServer -progressive slice\n"
" height parameter to n.\n"
" desktop:str set -desktop name to str for new clients.\n"
" rfbport:n set -rfbport to n.\n"
@@ -5540,7 +5560,7 @@ void print_help(int mode) {
"\n"
"%s\n"
"\n"
-"These options are passed to libvncserver:\n"
+"These options are passed to LibVNCServer:\n"
"\n"
;
/* have both our help and rfbUsage to stdout for more(1), etc. */
@@ -5571,7 +5591,7 @@ void print_help(int mode) {
}
p = strtok(NULL, "\n");
}
- fprintf(stderr, "\n\nlibvncserver options:\n");
+ fprintf(stderr, "\n\nLibVNCServer options:\n");
rfbUsage();
fprintf(stderr, "\n");
exit(1);