x11vnc.1 178 KB
Newer Older
1
.\" This file was automatically generated from x11vnc -help output.
2
.TH X11VNC "1" "July 2007" "x11vnc " "User Commands"
3 4
.SH NAME
x11vnc - allow VNC connections to real X11 displays
5
         version: 0.9.3, lastmod: 2007-07-03
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
.SH SYNOPSIS
.B x11vnc
[OPTION]...
.SH DESCRIPTION
.PP
Typical usage is:
.IP
Run this command in a shell on the remote machine "far-host"
with X session you wish to view:
.IP
x11vnc -display :0
.IP
Then run this in another window on the machine you are sitting at:
.IP
vncviewer far-host:0
.PP
22 23 24 25 26 27
Once x11vnc establishes connections with the X11 server and starts listening
as a VNC server it will print out a string: PORT=XXXX where XXXX is typically
5900 (the default VNC server port).  One would next run something like
this on the local machine: "vncviewer hostname:N" where "hostname" is
the name of the machine running x11vnc and N is XXXX - 5900, i.e. usually
"vncviewer hostname:0".
28
.PP
29
By default x11vnc will not allow the screen to be shared and it will exit
30
as soon as the client disconnects.  See \fB-shared\fR and \fB-forever\fR below to override
31 32
these protections.  See the FAQ for details how to tunnel the VNC connection
through an encrypted channel such as 
33
.IR ssh (1).
34
In brief:
35 36
.IP
ssh \fB-t\fR \fB-L\fR 5900:localhost:5900 far-host 'x11vnc \fB-localhost\fR \fB-display\fR :0'
37 38
.PP
% vncviewer -encodings 'copyrect tight zrle hextile' localhost:0
39
.PP
40
Also, use of a VNC password (-rfbauth or \fB-passwdfile)\fR is strongly recommended.
41
.PP
42 43 44
For additional info see: http://www.karlrunge.com/x11vnc/
and  http://www.karlrunge.com/x11vnc/#faq
.PP
45 46 47 48
Config file support: if the file $HOME/.x11vncrc exists then each line in
it is treated as a single command line option.  Disable with \fB-norc.\fR  For
each option name, the leading character "-" is not required.  E.g. a line
that is either "forever" or "\fB-forever\fR" may be used and are equivalent.
49
Likewise "wait 100" or "\fB-wait\fR \fI100\fR" are acceptable and equivalent lines.
50 51 52 53
The "#" character comments out to the end of the line in the usual way
(backslash it for a literal).  Leading and trailing whitespace is trimmed off.
Lines may be continued with a "\\" as the last character of a line (it
becomes a space character).
54 55 56 57 58 59 60 61 62
.PP
.SH OPTIONS

.PP
\fB-display\fR \fIdisp\fR
.IP
X11 server display to connect to, usually :0.  The X
server process must be running on same machine and
support MIT-SHM.  Equivalent to setting the DISPLAY
63 64 65 66 67 68
environment variable to \fIdisp\fR.
.IP
See the description below of the "\fB-display\fR \fIWAIT:...\fR"
extensions, where alias "\fB-find\fR" will find the user's
display automatically, and "\fB-create\fR" will create a
Xvfb session if no session is found.
69 70 71 72
.PP
\fB-auth\fR \fIfile\fR
.IP
Set the X authority file to be \fIfile\fR, equivalent to
73
setting the XAUTHORITY environment variable to \fIfile\fR
74
before startup.  Same as \fB-xauth\fR file.  See 
75
.IR Xsecurity (7)
76
,
77
.IR xauth (1)
78
man pages for more info.
79
.PP
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
\fB-N\fR
.IP
If the X display is :N, try to set the VNC display
to also be :N  This just sets the \fB-rfbport\fR option
to 5900+N.  The program will exit immediately if that
port is not available.
.PP
\fB-reflect\fR \fIhost:N\fR
.IP
Instead of connecting to and polling an X display,
connect to the remote VNC server host:N and be a
reflector/repeater for it.  This is useful for trying
to manage the case of many simultaneous VNC viewers
(e.g. classroom broadcasting) where, e.g. you put
a repeater on each network switch, etc, to improve
performance by distributing the load and network
traffic.  Implies \fB-shared\fR (use \fB-noshared\fR as a later
option to disable). See the discussion below under
\fB-rawfb\fR vnc:host:N for more details.
.PP
100 101
\fB-id\fR \fIwindowid\fR
.IP
102
Show the X window corresponding to \fIwindowid\fR not
103
the entire display.  New windows like popup menus,
104 105 106 107 108 109
transient toplevels, etc, may not be seen or may be
clipped.  Disabling SaveUnders or BackingStore in the
X server may help show them.  x11vnc may crash if the
window is initially partially obscured, changes size,
is iconified, etc.  Some steps are taken to avoid this
and the \fB-xrandr\fR mechanism is used to track resizes.  Use
110
.IR xwininfo (1)
111 112 113 114 115 116
to get the window id, or use "\fB-id\fR \fIpick\fR"
to have x11vnc run 
.IR xwininfo (1)
for you and extract
the id.  The \fB-id\fR option is useful for exporting very
simple applications (e.g. the current view on a webcam).
117 118 119 120
.PP
\fB-sid\fR \fIwindowid\fR
.IP
As \fB-id,\fR but instead of using the window directly it
121
shifts a root view to it: this shows SaveUnders menus,
122
etc, although they will be clipped if they extend beyond
123
the window.
124
.PP
125 126 127
\fB-clip\fR \fIWxH+X+Y\fR
.IP
Only show the sub-region of the full display that
128 129 130 131 132 133 134 135
corresponds to the rectangle geometry with size WxH and
offset +X+Y.  The VNC display has size WxH (i.e. smaller
than the full display).  This also works for \fB-id/-sid\fR
mode where the offset is relative to the upper left
corner of the selected window.  An example use of this
option would be to split a large (e.g. Xinerama) display
into two parts to be accessed via separate viewers by
running a separate x11vnc on each part.
136
.PP
137 138 139 140
\fB-flashcmap\fR
.IP
In 8bpp indexed color, let the installed colormap flash
as the pointer moves from window to window (slow).
141
Also try the \fB-8to24\fR option to avoid flash altogether.
142
.PP
143 144 145 146 147 148 149 150 151 152
\fB-shiftcmap\fR \fIn\fR
.IP
Rare problem, but some 8bpp displays use less than 256
colorcells (e.g. 16-color grayscale, perhaps the other
bits are used for double buffering) *and* also need to
shift the pixels values away from 0, .., ncells.  \fIn\fR
indicates the shift to be applied to the pixel values.
To see the pixel values set DEBUG_CMAP=1 to print out
a colormap histogram.  Example: \fB-shiftcmap\fR 240
.PP
153 154
\fB-notruecolor\fR
.IP
155
For 8bpp displays, force indexed color (i.e. a colormap)
156
even if it looks like 8bpp TrueColor (rare problem).
157
.PP
158 159
\fB-visual\fR \fIn\fR
.IP
160 161 162 163 164 165
This option probably does not do what you think.
It simply *forces* the visual used for the framebuffer;
this may be a bad thing... (e.g. messes up colors or
cause a crash). It is useful for testing and for some
workarounds.  n may be a decimal number, or 0x hex.
Run 
166
.IR xdpyinfo (1)
167 168 169 170
for the values.  One may also use
"TrueColor", etc. see <X11/X.h> for a list.  If the
string ends in ":m" then for better or for worse the
visual depth is forced to be m.
171
.PP
172 173 174 175 176 177
\fB-overlay\fR
.IP
Handle multiple depth visuals on one screen, e.g. 8+24
and 24+8 overlay visuals (the 32 bits per pixel are
packed with 8 for PseudoColor and 24 for TrueColor).
.IP
178 179 180 181 182 183 184 185
Currently \fB-overlay\fR only works on Solaris via
.IR XReadScreen (3X11)
and IRIX using 
.IR XReadDisplay (3).
On Solaris there is a problem with image "bleeding"
around transient popup menus (but not for the menu
itself): a workaround is to disable SaveUnders
by passing the "\fB-su\fR" argument to Xsun (in
186
/etc/dt/config/Xservers).
187 188
.IP
Use \fB-overlay\fR as a workaround for situations like these:
189
Some legacy applications require the default visual to
190 191
be 8bpp (8+24), or they will use 8bpp PseudoColor even
when the default visual is depth 24 TrueColor (24+8).
192 193
In these cases colors in some windows will be incorrect
in x11vnc unless \fB-overlay\fR is used.  Another use of
194 195
\fB-overlay\fR is to enable showing the exact mouse cursor
shape (details below).
196
.IP
197
Under \fB-overlay,\fR performance will be somewhat slower
198 199 200
due to the extra image transformations required.
For optimal performance do not use \fB-overlay,\fR but rather
configure the X server so that the default visual is
201
depth 24 TrueColor and try to have all apps use that
202
visual (e.g. some apps have \fB-use24\fR or \fB-visual\fR options).
203 204 205 206 207
.PP
\fB-overlay_nocursor\fR
.IP
Sets \fB-overlay,\fR but does not try to draw the exact mouse
cursor shape using the overlay mechanism.
208
.PP
209
\fB-8to24\fR \fI[opts]\fR
210
.IP
211 212 213
Try this option if \fB-overlay\fR is not supported on your
OS, and you have a legacy 8bpp app that you want to
view on a multi-depth display with default depth 24
214
(and is 32 bpp) OR have a default depth 8 display with
215
depth 24 overlay windows for some apps.  This option
216 217 218
may not work on all X servers and hardware (tested
on XFree86/Xorg mga driver and Xsun).  The "opts"
string is not required and is described below.
219 220 221
.IP
This mode enables a hack where x11vnc monitors windows
within 3 levels from the root window.  If it finds
222 223 224 225 226 227 228 229 230 231 232 233 234 235
any that are 8bpp it extracts the indexed color
pixel values using XGetImage() and then applies a
transformation using the colormap(s) to create TrueColor
RGB values that it in turn inserts into bits 1-24 of
the framebuffer.  This creates a depth 24 "view"
of the display that is then exported via VNC.
.IP
Conversely, for default depth 8 displays, the depth
24 regions are read by XGetImage() and everything is
transformed and inserted into a depth 24 TrueColor
framebuffer.
.IP
Note that even if there are *no* depth 24 visuals or
windows (i.e. pure 8bpp), this mode is potentially
236
an improvement over \fB-flashcmap\fR because it avoids the
237 238 239 240 241 242 243 244 245
flashing and shows each window in the correct color.
.IP
This method appear to work, but may still have bugs
and it does hog resources.  If there are multiple 8bpp
windows using different colormaps, one may have to
iconify all but one for the colors to be correct.
.IP
There may be painting errors for clipping and switching
between windows of depths 8 and 24.  Heuristics are
246 247 248 249 250 251
applied to try to minimize the painting errors.  One can
also press 3 Alt_L's in a row to refresh the screen
if the error does not repair itself.  Also the option
\fB-fixscreen\fR 8=3.0 or \fB-fixscreen\fR V=3.0 may be used to
periodically refresh the screen at the cost of bandwidth
(every 3 sec for this example).
252
.IP
253 254
The [opts] string can contain the following settings.
Multiple settings are separated by commas.
255
.IP
256 257 258 259 260
For for some X servers with default depth 24 a
speedup may be achieved via the option "nogetimage".
This enables a scheme were XGetImage() is not used
to retrieve the 8bpp data.  Instead, it assumes that
the 8bpp data is in bits 25-32 of the 32bit X pixels.
261 262 263 264 265
There is no requirement that the X server should put
the data there for our poll requests, but some do and
so the extra steps to retrieve it can be skipped.
Tested with mga driver with XFree86/Xorg.  For the
default depth 8 case this option is ignored.
266 267 268 269 270
.IP
To adjust how often XGetImage() is used to poll the
non-default visual regions for changes, use the option
"poll=t" where "t" is a floating point time.
(default: 0.05)
271
.IP
272 273 274 275 276 277 278 279 280 281 282 283
Setting the option "level2" will limit the search
for non-default visual windows to two levels from the
root window.  Do this on slow machines where you know
the window manager only imposes one extra window between
the app window and the root window.
.IP
Also for very slow machines use "cachewin=t"
where t is a floating point amount of time to cache
XGetWindowAttributes results.  E.g. cachewin=5.0.
This may lead to the windows being unnoticed for this
amount of time when deiconifying, painting errors, etc.
.IP
284 285 286 287 288
While testing on a very old SS20 these options gave
tolerable response: \fB-8to24\fR poll=0.2,cachewin=5.0. For
this machine \fB-overlay\fR is supported and gives better
response.
.IP
289
Debugging for this mode can be enabled by setting
290
"dbg=1", "dbg=2", or "dbg=3".
291
.PP
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
\fB-24to32\fR
.IP
Very rare problem: if the framebuffer (X display
or \fB-rawfb)\fR is 24bpp instead of the usual 32bpp, then
dynamically transform the pixels to 32bpp.  This will be
slower, but can be used to work around problems where
VNC viewers cannot handle 24bpp (e.g. "main: setPF:
not 8, 16 or 32 bpp?").  See the FAQ for more info.
.IP
In the case of \fB-rawfb\fR mode, the pixels are directly
modified by inserting a 0 byte to pad them out to 32bpp.
For X displays, a kludge is done that is equivalent to
"\fB-noshm\fR \fI\fB-visual\fR TrueColor:32\fR".  (If better performance
is needed for the latter, feel free to ask).
.PP
307 308
\fB-scale\fR \fIfraction\fR
.IP
309
Scale the framebuffer by factor \fIfraction\fR.  Values
310 311
less than 1 shrink the fb, larger ones expand it.  Note:
image may not be sharp and response may be slower.
312 313 314
If \fIfraction\fR contains a decimal point "." it
is taken as a floating point number, alternatively
the notation "m/n" may be used to denote fractions
315
exactly, e.g. \fB-scale\fR 2/3
316
.IP
317
Scaling Options: can be added after \fIfraction\fR via
318 319 320 321 322 323 324 325 326 327 328
":", to supply multiple ":" options use commas.
If you just want a quick, rough scaling without
blending, append ":nb" to \fIfraction\fR (e.g. \fB-scale\fR
1/3:nb).  No blending is the default for 8bpp indexed
color, to force blending for this case use ":fb".
.IP
To disable \fB-scrollcopyrect\fR and \fB-wirecopyrect\fR under
\fB-scale\fR use ":nocr".  If you need to to enable them use
":cr" or specify them explicitly on the command line.
If a slow link is detected, ":nocr" may be applied
automatically.  Default: :cr
329 330
.IP
More esoteric options: for compatibility with vncviewers
331
the scaled width is adjusted to be a multiple of 4:
332
to disable this use ":n4".  ":in" use interpolation
333
scheme even when shrinking, ":pad" pad scaled width
334 335
and height to be multiples of scaling denominator
(e.g. 3 for 2/3).
336
.PP
337 338 339 340 341 342 343 344 345 346 347
\fB-scale_cursor\fR \fIfrac\fR
.IP
By default if \fB-scale\fR is supplied the cursor shape is
scaled by the same factor.  Depending on your usage,
you may want to scale the cursor independently of the
screen or not at all.  If you specify \fB-scale_cursor\fR
the cursor will be scaled by that factor.  When using
\fB-scale\fR mode to keep the cursor at its "natural" size
use "\fB-scale_cursor\fR \fI1\fR".  Most of the ":" scaling
options apply here as well.
.PP
348 349 350 351 352 353
\fB-viewonly\fR
.IP
All VNC clients can only watch (default off).
.PP
\fB-shared\fR
.IP
354 355
VNC display is shared, i.e. more than one viewer can
connect at the same time (default off).
356 357 358 359 360 361 362 363 364 365 366
.PP
\fB-once\fR
.IP
Exit after the first successfully connected viewer
disconnects, opposite of \fB-forever.\fR This is the Default.
.PP
\fB-forever\fR
.IP
Keep listening for more connections rather than exiting
as soon as the first client(s) disconnect. Same as \fB-many\fR
.PP
runge's avatar
runge committed
367 368 369
\fB-loop\fR
.IP
Create an outer loop restarting the x11vnc process
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
whenever it terminates.  \fB-bg\fR and \fB-inetd\fR are ignored
in this mode (however see \fB-loopbg\fR below).
.IP
Useful for continuing even if the X server terminates
and restarts (at that moment the process will need
permission to reconnect to the new X server of course).
.IP
Use, e.g., \fB-loop100\fR to sleep 100 millisecs between
restarts, etc.  Default is 2000ms (i.e. 2 secs) Use,
e.g. \fB-loop300,5\fR to sleep 300 ms and only loop 5 times.
.IP
If \fB-loopbg\fR (plus any numbers) is specified instead,
the "\fB-bg\fR" option is implied and the mode approximates
.IR inetd (8)
usage to some degree.  In this case when
it goes into the background any listening sockets
(i.e. ports 5900, 5800) are closed, so the next one
in the loop can use them.  This mode will only be of
use if a VNC client (the only client for that process)
is already connected before the process goes into the
background, for example, usage of \fB-display\fR WAIT:..,
\fB-svc,\fR and \fB-connect\fR can make use of this "poor man's"
inetd mode.  The default wait time is 500ms in this
mode.  This usage could use useful:  \fB-svc\fR \fB-loopbg\fR
runge's avatar
runge committed
394
.PP
395 396 397
\fB-timeout\fR \fIn\fR
.IP
Exit unless a client connects within the first n seconds
398
after startup.
399
.PP
400 401 402 403 404
\fB-sleepin\fR \fIn\fR
.IP
At startup sleep n seconds before proceeding (e.g. to
allow redirs and listening clients to start up)
.PP
405 406 407
\fB-inetd\fR
.IP
Launched by 
408
.IR inetd (8):
409 410
stdio instead of listening socket.
Note: if you are not redirecting stderr to a log file
411
(via shell 2> or \fB-o\fR option) you MUST also specify the \fB-q\fR
412 413 414
option, otherwise the stderr goes to the viewer which
will cause it to abort.  Specifying both \fB-inetd\fR and \fB-q\fR
and no \fB-o\fR will automatically close the stderr.
415
.PP
416
\fB-tightfilexfer\fR
417
.IP
418 419 420 421 422 423 424
Enable the TightVNC file transfer extension. Note that
that when the \fB-viewonly\fR option is supplied all file
transfers are disabled.  Also clients that log in
viewonly cannot transfer files.  However, if the remote
control mechanism is used to change the global or
per-client viewonly state the filetransfer permissions
will NOT change.
runge's avatar
runge committed
425 426 427 428 429 430 431 432 433
.IP
IMPORTANT: please understand if \fB-tightfilexfer\fR is
specified and you run x11vnc as root for, say, inetd
or display manager (gdm, kdm, ...) access and you do
not have it switch users via the \fB-users\fR option, then
VNC Viewers that connect are able to do filetransfer
reads and writes as *root*.
.IP
Also, tightfilexfer is disabled in \fB-unixpw\fR mode.
434 435
.PP
\fB-ultrafilexfer\fR
436
.IP
437 438
Note: to enable UltraVNC filetransfer and to get it to
work you probably need to supply these libvncserver
439
options: "\fB-rfbversion\fR \fI3.6 \fB-permitfiletransfer\fR"\fR
440
"\fB-ultrafilexfer\fR" is an alias for this combination.
441
.IP
runge's avatar
runge committed
442 443 444 445 446 447 448
IMPORTANT: please understand if \fB-ultrafilexfer\fR is
specified and you run x11vnc as root for, say, inetd
or display manager (gdm, kdm, ...) access and you do
not have it switch users via the \fB-users\fR option, then
VNC Viewers that connect are able to do filetransfer
reads and writes as *root*.
.IP
449 450 451
Note that sadly you cannot do both \fB-tightfilexfer\fR and
\fB-ultrafilexfer\fR at the same time because the latter
requires setting the version to 3.6 and tightvnc will
452
not do filetransfer when it sees that version number.
453
.PP
454 455 456 457 458 459
\fB-http\fR
.IP
Instead of using \fB-httpdir\fR (see below) to specify
where the Java vncviewer applet is, have x11vnc try
to *guess* where the directory is by looking relative
to the program location and in standard locations
460 461 462
(/usr/local/share/x11vnc/classes, etc).  Under \fB-ssl\fR or
\fB-stunnel\fR the ssl classes subdirectory is sought.
.PP
463 464 465 466
\fB-http_ssl\fR
.IP
As \fB-http,\fR but force lookup for ssl classes subdir.
.PP
467 468 469 470 471 472 473 474 475 476 477 478
\fB-avahi\fR
.IP
Use the Avahi/mDNS ZeroConf protocol to advertize
this VNC server to the local network. (Related terms:
Rendezvous, Bonjour).  Depending on your setup, you
may need to start avahi-daemon and open udp port 5353
in your firewall.
.PP
\fB-mdns\fR
.IP
Same as \fB-avahi.\fR
.PP
479 480 481 482 483
\fB-connect\fR \fIstring\fR
.IP
For use with "vncviewer -listen" reverse connections.
If \fIstring\fR has the form "host" or "host:port"
the connection is made once at startup.  Use commas
484 485
for a list of host's and host:port's.
.IP
486 487 488 489 490 491 492
Note that unlike most vnc servers, x11vnc will require a
password for reverse as well as for forward connections.
(provided password auth has been enabled, \fB-rfbauth,\fR etc)
If you do not want to require a password for reverse
connections set X11VNC_REVERSE_CONNECTION_NO_AUTH=1 in
your environment before starting x11vnc.
.IP
493 494 495
If \fIstring\fR contains "/" it is instead interpreted
as a file to periodically check for new hosts.
The first line is read and then the file is truncated.
496 497
Be careful about the location of this file if x11vnc
is running as root (e.g. via 
498
.IR gdm (1)
499
, etc).
500
.PP
501 502 503 504 505 506 507 508
\fB-connect_or_exit\fR \fIstr\fR
.IP
As with \fB-connect,\fR except if none of the reverse
connections succeed, then x11vnc shutdowns immediately.
.IP
If you do not want x11vnc to listen on ANY interface
use \fB-rfbport\fR 0
.PP
509
\fB-vncconnect,\fR \fB-novncconnect\fR
510 511 512
.IP
Monitor the VNC_CONNECT X property set by the standard
VNC program 
513 514
.IR vncconnect (1).
When the property is
515 516
set to "host" or "host:port" establish a reverse
connection.  Using 
517
.IR xprop (1)
518
instead of vncconnect may
519 520 521
work (see the FAQ).  The \fB-remote\fR control mechanism uses
X11VNC_REMOTE channel, and this option disables/enables
it as well.  Default: \fB-vncconnect\fR
522
.PP
523
\fB-allow\fR \fIhost1[,host2..]\fR
524
.IP
525 526 527 528 529 530 531 532 533
Only allow client connections from hosts matching
the comma separated list of hostnames or IP addresses.
Can also be a numerical IP prefix, e.g. "192.168.100."
to match a simple subnet, for more control build
libvncserver with libwrap support (See the FAQ).  If the
list contains a "/" it instead is a interpreted as a
file containing addresses or prefixes that is re-read
each time a new client connects.  Lines can be commented
out with the "#" character in the usual way.
534 535 536
.PP
\fB-localhost\fR
.IP
537
Basically the same as "\fB-allow\fR \fI127.0.0.1\fR".
runge's avatar
runge committed
538 539 540 541 542 543 544
.IP
Note: if you want to restrict which network interface
x11vnc listens on, see the \fB-listen\fR option below.
E.g. "\fB-listen\fR \fIlocalhost\fR" or "\fB-listen\fR \fI192.168.3.21\fR".
As a special case, the option "\fB-localhost\fR" implies
"\fB-listen\fR \fIlocalhost\fR".
.IP
545 546 547 548 549
A rare case, but for non-localhost \fB-listen\fR usage, if
you use the remote control mechanism (-R) to change
the \fB-listen\fR interface you may need to manually adjust
the \fB-allow\fR list (and vice versa) to avoid situations
where no connections (or too many) are allowed.
550 551 552 553 554
.IP
If you do not want x11vnc to listen on ANY interface
(evidently you are using \fB-connect\fR or \fB-connect_or_exit,\fR
or plan to use remote control: \fB-R\fR connect:host), use
\fB-rfbport\fR 0
555
.PP
556 557 558 559 560
\fB-nolookup\fR
.IP
Do not use gethostbyname() or gethostbyaddr() to look up
host names or IP numbers.  Use this if name resolution
is incorrectly set up and leads to long pauses as name
561
lookups time out, etc.
562
.PP
563 564 565 566
\fB-input\fR \fIstring\fR
.IP
Fine tuning of allowed user input.  If \fIstring\fR does
not contain a comma "," the tuning applies only to
567 568 569 570 571 572
normal clients.  Otherwise the part before "," is
for normal clients and the part after for view-only
clients.  "K" is for Keystroke input, "M" for
Mouse-motion input, "B" for Button-click input, "C"
is for Clipboard input, and "F" is for File transfer
(ultravnc only).  Their presence in the string enables
573
that type of input.  E.g. "\fB-input\fR \fIM\fR" means normal
574
users can only move the mouse and  "\fB-input\fR \fIKMBCF,M\fR"
575 576 577 578
lets normal users do anything and enables view-only
users to move the mouse.  This option is ignored when
a global \fB-viewonly\fR is in effect (all input is discarded
in that case).
579
.PP
580 581
\fB-grabkbd\fR
.IP
582 583 584 585
When VNC viewers are connected, attempt to the grab
the keyboard so a (non-malicious) user sitting at the
physical display is not able to enter keystrokes.
This method uses 
586
.IR XGrabKeyboard (3X11)
587 588 589 590 591 592 593
and so it is
not secure and does not rule out the person at the
physical display injecting keystrokes by flooding the
server with them, grabbing the keyboard himself, etc.
Some degree of cooperation from the person at the
display is assumed.  This is intended for remote
help-desk or educational usage modes.
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
.PP
\fB-grabptr\fR
.IP
As \fB-grabkbd,\fR but for the mouse pointer using
.IR XGrabPointer (3X11).
Unfortunately due to the way the X
server works, the mouse can still be moved around by the
user at the physical display, but he will not be able to
change window focus with it.  Also some window managers
that call 
.IR XGrabServer (3X11)
for resizes, etc, will
act on the local user's input.  Again, some degree of
cooperation from the person at the display is assumed.
.PP
609 610 611 612 613 614 615
\fB-grabalways\fR
.IP
Apply both \fB-grabkbd\fR and \fB-grabptr\fR even when no VNC
viewers are connected.  If you only want one of them,
use the \fB-R\fR remote control to turn the other back on,
e.g. \fB-R\fR nograbptr.
.PP
616 617 618 619 620 621 622
\fB-viewpasswd\fR \fIstring\fR
.IP
Supply a 2nd password for view-only logins.  The \fB-passwd\fR
(full-access) password must also be supplied.
.PP
\fB-passwdfile\fR \fIfilename\fR
.IP
623 624 625
Specify the libvncserver password via the first line
of the file \fIfilename\fR (instead of via \fB-passwd\fR on
the command line where others might see it via 
626
.IR ps (1)
627
).
628 629 630 631
.IP
See the descriptions below for how to supply multiple
passwords, view-only passwords, to specify external
programs for the authentication, and other features.
632 633
.IP
If the filename is prefixed with "rm:" it will be
runge's avatar
runge committed
634
removed after being read.  Perhaps this is useful in
635 636 637 638
limiting the readability of the file.  In general, the
password file should not be readable by untrusted users
(BTW: neither should the VNC \fB-rfbauth\fR file: it is NOT
encrypted, only obscured with a fixed key).
runge's avatar
runge committed
639 640
.IP
If the filename is prefixed with "read:" it will
641
periodically be checked for changes and reread.  It is
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
guaranteed to be reread just when a new client connects
so that the latest passwords will be used.
.IP
If \fIfilename\fR is prefixed with "cmd:" then the
string after the ":" is run as an external command:
the output of the command will be interpreted as if it
were read from a password file (see below).  If the
command does not exit with 0, then x11vnc terminates
immediately.  To specify more than 1000 passwords this
way set X11VNC_MAX_PASSWDS before starting x11vnc.
The environment variables are set as in \fB-accept.\fR
.IP
Note that due to the VNC protocol only the first 8
characters of a password are used (DES key).
.IP
If \fIfilename\fR is prefixed with "custom:" then a
custom password checker is supplied as an external
command following the ":". The command will be run
when a client authenticates.  If the command exits with
0 the client is accepted, otherwise it is rejected.
The environment variables are set as in \fB-accept.\fR
.IP
The standard input to the custom command will be a
decimal digit "len" followed by a newline. "len"
specifies the challenge size and is usually 16 (the
VNC spec).  Then follows len bytes which is the random
challenge string that was sent to the client. This is
then followed by len more bytes holding the client's
response (i.e. the challenge string encrypted via DES
with the user password in the standard situation).
.IP
The "custom:" scheme can be useful to implement
dynamic passwords or to implement methods where longer
passwords and/or different encryption algorithms
are used.  The latter will require customizing the VNC
client as well.  One could create an MD5SUM based scheme
for example.
.IP
File format for \fB-passwdfile:\fR
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
.IP
If multiple non-blank lines exist in the file they are
all taken as valid passwords.  Blank lines are ignored.
Password lines may be "commented out" (ignored) if
they begin with the charactor "#" or the line contains
the string "__SKIP__".  Lines may be annotated by use
of the "__COMM__" string: from it to the end of the
line is ignored.  An empty password may be specified
via the "__EMPTY__" string on a line by itself (note
your viewer might not accept empty passwords).
.IP
If the string "__BEGIN_VIEWONLY__" appears on a
line by itself, the remaining passwords are used for
viewonly access.  For compatibility, as a special case
if the file contains only two password lines the 2nd
one is automatically taken as the viewonly password.
runge's avatar
runge committed
697 698 699 700
Otherwise the "__BEGIN_VIEWONLY__" token must be
used to have viewonly passwords.  (tip: make the 3rd
and last line be "__BEGIN_VIEWONLY__" to have 2
full-access passwords)
701
.PP
702 703 704 705 706 707 708
\fB-unixpw\fR \fI[list]\fR
.IP
Use Unix username and password authentication.  x11vnc
uses the 
.IR su (1)
program to verify the user's password.
[list] is an optional comma separated list of allowed
709 710 711 712
Unix usernames.  If the [list] string begins with the
character "!" then the entire list is taken as an
exclude list.  See below for per-user options that can
be applied.
713 714 715 716 717 718 719 720
.IP
A familiar "login:" and "Password:" dialog is
presented to the user on a black screen inside the
vncviewer.  The connection is dropped if the user fails
to supply the correct password in 3 tries or does not
send one before a 25 second timeout.  Existing clients
are view-only during this period.
.IP
721 722 723 724 725
If the first character received is "Escape" then the
unix username will not be displayed after "login:"
as it is typed.  This could be of use for VNC viewers
that automatically type the username and password.
.IP
726 727 728 729
Since the detailed behavior of 
.IR su (1)
can vary from
OS to OS and for local configurations, test the mode
730
carefully.  x11vnc will attempt to be conservative and
731 732
reject a login if anything abnormal occurs.
.IP
733 734 735
One case to note: FreeBSD and the other BSD's by
default it is impossible for the user running x11vnc to
validate his *own* password via 
736
.IR su (1)
737
(commenting out
738
the pam_self.so entry in /etc/pam.d/su eliminates this
739
behavior).  So the x11vnc login will always *FAIL* for
740 741
this case (even when the correct password is supplied).
.IP
742 743 744 745 746 747 748 749 750
A possible workaround for this on *BSD would be to
start x11vnc as root with the "\fB-users\fR \fI+nobody\fR" option
to immediately switch to user nobody where the su'ing
will proceed normally.
.IP
Another source of potential problems are PAM modules
that prompt for extra info, e.g. password aging modules.
These logins will fail as well even when the correct
password is supplied.
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
.IP
**IMPORTANT**: to prevent the Unix password being sent
in *clear text* over the network, one of two schemes
will be enforced: 1) the \fB-ssl\fR builtin SSL mode, or 2)
require both \fB-localhost\fR and \fB-stunnel\fR be enabled.
.IP
Method 1) ensures the traffic is encrypted between
viewer and server.  A PEM file will be required, see the
discussion under \fB-ssl\fR below (under some circumstances
a temporary one can be automatically generated).
.IP
Method 2) requires the viewer connection to appear
to come from the same machine x11vnc is running on
(e.g. from a ssh \fB-L\fR port redirection).  And that the
\fB-stunnel\fR SSL mode be used for encryption over the
network.(see the description of \fB-stunnel\fR below).
.IP
Note: as a convenience, if you 
.IR ssh (1)
in and start
x11vnc it will check if the environment variable
SSH_CONNECTION is set and appears reasonable.  If it
does, then the \fB-ssl\fR or \fB-stunnel\fR requirement will be
dropped since it is assumed you are using ssh for the
encrypted tunnelling.  \fB-localhost\fR is still enforced.
Use \fB-ssl\fR or \fB-stunnel\fR to force SSL usage even if
SSH_CONNECTION is set.
.IP
To override the above restrictions you can set
environment variables before starting x11vnc:
.IP
Set UNIXPW_DISABLE_SSL=1 to disable requiring either
\fB-ssl\fR or \fB-stunnel.\fR  Evidently you will be using a
different method to encrypt the data between the
vncviewer and x11vnc: perhaps 
.IR ssh (1)
or an IPSEC VPN.
.IP
Note that use of \fB-localhost\fR with 
.IR ssh (1)
is roughly
the same as requiring a Unix user login (since a Unix
password or the user's public key authentication is
used by sshd on the machine where x11vnc runs and only
795
local connections from that machine are accepted).
796 797 798 799 800 801 802 803 804 805 806 807
.IP
Set UNIXPW_DISABLE_LOCALHOST=1 to disable the \fB-localhost\fR
requirement in Method 2).  One should never do this
(i.e. allow the Unix passwords to be sniffed on the
network).
.IP
Regarding reverse connections (e.g. \fB-R\fR connect:host
and \fB-connect\fR host), when the \fB-localhost\fR constraint is
in effect then reverse connections can only be used
to connect to the same machine x11vnc is running on
(default port 5500).  Please use a ssh or stunnel port
redirection to the viewer machine to tunnel the reverse
808
connection over an encrypted channel.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
.IP
In \fB-inetd\fR mode the Method 1) will be enforced (not
Method 2).  With \fB-ssl\fR in effect reverse connections
are disabled.  If you override this via env. var, be
sure to also use encryption from the viewer to inetd.
Tip: you can also have your own stunnel spawn x11vnc
in \fB-inetd\fR mode (thereby bypassing inetd).  See the FAQ
for details.
.IP
The user names in the comma separated [list] can have
per-user options after a ":", e.g. "fred:opts"
where "opts" is a "+" separated list of
"viewonly", "fullaccess", "input=XXXX", or
"deny", e.g. "karl,wally:viewonly,boss:input=M".
For "input=" it is the K,M,B,C described under \fB-input.\fR
.IP
825
If an item in the list is "*" that means those
826 827 828
options apply to all users.  It also means all users
are allowed to log in after supplying a valid password.
Use "deny" to explicitly deny some users if you use
829 830 831 832
"*" to set a global option.  If [list] begins with
the "!" character then "*" is ignored for checking
if the user is allowed, but the any value of options
associated with it does apply as normal.
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
.IP
There are also some utilities for testing password
if [list] starts with the "%" character.  See the
quick_pw() function in the source for details.
.PP
\fB-unixpw_nis\fR \fI[list]\fR
.IP
As \fB-unixpw\fR above, however do not use 
.IR su (1)
but rather
use the traditional 
.IR getpwnam (3)
+ 
.IR crypt (3)
method to
848 849 850 851 852 853
verify passwords. All of the above \fB-unixpw\fR options and
contraints apply.
.IP
This mode requires that the encrypted passwords be
readable.  Encrypted passwords stored in /etc/shadow
will be inaccessible unless x11vnc is run as root.
854 855
.IP
This is called "NIS" mode simply because in most
856 857 858 859 860
NIS setups user encrypted passwords are accessible
(e.g. "ypcat passwd") by an ordinary user and so that
user can authenticate ANY user.
.IP
NIS is not required for this mode to work (only that
861
.IR getpwnam (3)
862 863 864 865 866 867 868 869 870 871 872 873 874
return the encrypted password is required),
but it is unlikely it will work for any most modern
environments unless x11vnc is run as root to be able
to access /etc/shadow (note running as root is often
done when running x11vnc from inetd and xdm/gdm/kdm).
.IP
Looked at another way, if you do not want to use the
.IR su (1)
method provided by \fB-unixpw,\fR you can run x11vnc
as root and use \fB-unixpw_nis.\fR  Any users with passwords
in /etc/shadow can then be authenticated.  You may want
to use \fB-users\fR unixpw= to switch the process user after
the user logs in.
875
.PP
876
\fB-unixpw_cmd\fR \fIcmd\fR
877 878 879 880
.IP
As \fB-unixpw\fR above, however do not use 
.IR su (1)
but rather
881
run the externally supplied command \fIcmd\fR.  The first
882 883 884
line of its stdin will the username and the second line
the received password.  If the command exits with status
0 (success) the VNC client will be accepted.  It will be
885 886 887 888 889 890 891 892 893
rejected for any other return status.
.IP
Dynamic passwords and non-unix passwords can be
implemented this way by providing your own custom helper
program.  Note that under unixpw mode the remote viewer
is given 3 tries to enter the correct password.
.IP
If a list of allowed users is needed use \fB-unixpw\fR [list]
in addition to this option.
894
.PP
895 896 897 898 899 900 901 902 903 904 905 906
\fB-find\fR
.IP
Find the user's display using FINDDISPLAY. It is an
alias for "\fB-display\fR \fIWAIT:cmd=FINDDISPLAY\fR".
.PP
\fB-create\fR
.IP
First try to find the user's display using FINDDISPLAY,
if that doesn't work create an X session via the
FINDCREATEDISPLAY method. This is an alias for
"\fB-display\fR \fIWAIT:cmd=FINDCREATEDISPLAY-Xvfb\fR".
.PP
907 908
\fB-svc\fR
.IP
909
Terminal services mode. Also "\fB-service\fR". Alias for
910 911 912 913 914
\fB-display\fR WAIT:cmd=FINDCREATEDISPLAY-Xvfb \fB-unixpw\fR
\fB-users\fR unixpw= \fB-ssl\fR SAVE
.PP
\fB-xdmsvc\fR
.IP
915
Terminal services mode. Also "\fB-xdm_service\fR". Alias for
916 917 918
\fB-display\fR WAIT:cmd=FINDCREATEDISPLAY-Xvfb.xdmcp \fB-unixpw\fR
\fB-users\fR unixpw= \fB-ssl\fR SAVE
.PP
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
\fB-display\fR \fIWAIT:...\fR
.IP
A special usage mode for the normal \fB-display\fR option.
Useful with \fB-unixpw,\fR but can be used independently
of it.  If the display string begins with WAIT: then
x11vnc waits until a VNC client connects before opening
the X display (or \fB-rawfb\fR device).
.IP
This could be useful for delaying opening the display
for certain usage modes (say if x11vnc is started at
boot time and no X server is running or users logged
in yet).
.IP
If the string is, e.g. WAIT:0.0 or WAIT:1, i.e. "WAIT"
in front of a normal X display, then that indicated
934 935 936 937 938 939 940 941
display is used.
.IP
One can also insert a geometry between colons, e.g.
WAIT:1280x1024:... to set the size of the display the
VNC client first attaches to since some VNC viewers
will not automatically adjust to a new framebuffer size.
.IP
A more interesting case is like this:
942 943 944 945 946 947
.IP
WAIT:cmd=/usr/local/bin/find_display
.IP
in which case the command after "cmd=" is run to
dynamically work out the DISPLAY and optionally the
XAUTHORITY data.  The first line of the command output
948 949 950 951 952 953 954 955 956
must be of the form DISPLAY=<xdisplay>.  On Linux
if the virtual terminal is known append ",VT=n" to
this string and the 
.IR chvt (1)
program will also be run.
Any remaining output is taken as XAUTHORITY data.
It can be either of the form XAUTHORITY=<file> or raw
xauthority data for the display (e.g. "xauth extract -
$DISPLAY" output).
957
.IP
958 959 960 961
In the case of \fB-unixpw\fR (but not \fB-unixpw_nis),\fR then the
above command is run as the user who just authenticated
via the login and password prompt.
.IP
962
Also in the case of \fB-unixpw,\fR the user logging in can
963
place a colon at the end of her username and supply
964 965
a few options: scale=, scale_cursor= (or sc=), solid
(or so), id=, clear_mods (or cm), clear_keys (or ck),
966 967 968 969 970
repeat, speeds= (or sp=), readtimeout= (or rd=),
rotate= (or ro=), or noncache (or nc) separated by
commas if there is more than one.  After the user logs
in successfully, these options will be applied to the
VNC screen.  For example,
971 972 973 974
.IP
login: fred:scale=3/4,sc=1,repeat
Password: ...
.IP
975
login: runge:sp=modem,rd=120,solid
976
.IP
977 978 979 980
for convenience m/n implies scale= e.g. fred:3/4  If you
type and enter your password incorrectly, to retrieve
your long "login:" line press the Up arrow once
(before typing anything else).
981
.IP
982 983 984 985
Another option is "geom=WxH" or "geom=WxHxD"
(or ge=). This only has an effect in FINDCREATEDISPLAY
mode when a virtual X server such as Xvfb is going to
be created.  It sets the width and height of the new
986 987 988 989
display, and optionally the color depth as well. You
can also supply "kde", "gnome", "fvwm", "twm",
or "failsafe" to have the created display use that
mode for the user session.
990
.IP
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
To disable the option setting set the environment
variable X11VNC_NO_UNIXPW_OPTS=1 before starting x11vnc.
To set any other options, the user can use the gui
(x11vnc \fB-gui\fR connect) or the remote control method
(x11vnc \fB-R\fR opt:val) during his VNC session.
.IP
The combination of \fB-display\fR WAIT:cmd=... and \fB-unixpw\fR
allows automatic pairing of an unix authenticated VNC
user with his desktop.  This could be very useful on
SunRays and also any system where multiple users share
a given machine.  The user does not need to remember
special ports or passwords set up for his desktop
and VNC.
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
.IP
A nice way to use WAIT:cmd=... is out of 
.IR inetd (8)
(it automatically forks a new x11vnc for each user).
You can have the x11vnc inetd spawned process run as,
say, root or nobody.  When run as root (for either inetd
or display manager), you can also supply the option
"\fB-users\fR \fIunixpw=\fR" to have the x11vnc process switch to
the user as well.  Note: there will be a 2nd SSL helper
process that will not switch, but it is only encoding
and decoding the encrypted stream at that point.
.IP
1016 1017 1018 1019 1020
As a special case, WAIT:cmd=FINDDISPLAY will run a
script that works on most Unixes to determine a user's
DISPLAY variable and xauthority data (see 
.IR who (1)
).
1021
.IP
1022
To have this default script printed to stdout (e.g. for
1023 1024 1025 1026 1027 1028 1029 1030
customization) run with WAIT:cmd=FINDDISPLAY-print
.IP
As another special case, WAIT:cmd=HTTPONCE will allow
x11vnc to service one http request and then exit.
This is usually done in \fB-inetd\fR mode to run on, say,
port 5800 and allow the Java vncviewer to be downloaded
by client web browsers.  For example:
.IP
1031 1032 1033
5815 stream tcp nowait root /usr/sbin/tcpd /.../x11vnc \\
\fB-inetd\fR \fB-q\fR \fB-http_ssl\fR \fB-prog\fR /.../x11vnc \\
\fB-display\fR WAIT:cmd=HTTPONCE
1034
.IP
1035
Where /.../x11vnc is the full path to x11vnc.
1036
It is used in the Apache SSL-portal example (see FAQ).
1037
.IP
1038 1039
In this mode you can set X11VNC_SKIP_DISPLAY to a comma
separated list of displays (e.g. ":0,:1") to ignore
1040 1041
in the finding process.  This can also be set by the
user via "nd=" using "-" instead of ","
1042
.IP
1043
An interesting option is WAIT:cmd=FINDCREATEDISPLAY
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
that is like FINDDISPLAY in that is uses the same method
to find an existing display.  However, if it does not
find one it will try to *start* up an X server session
for the user.  This is the only time x11vnc tries to
start up an X server.
.IP
By default FINDCREATEDISPLAY will try Xdummy and
then Xvfb.  The Xdummy wrapper is part of the x11vnc
source code (x11vnc/misc/Xdummy)  It should be available
in PATH and have run "Xdummy \fB-install"\fR once to create
the shared library.  Xdummy requires root permission
and only works on Linux.  Xvfb is available on most
1056
platforms and does not require root.
1057
.IP
1058 1059 1060 1061 1062 1063
When x11vnc exits (i.e. user disconnects) the X
server session stays running in the background.
The FINDDISPLAY will find it directly next time.
The user must exit the X session in the usual way for
it to terminate (or kill the X server process if all
else fails).
1064 1065
.IP
So this is a somewhat odd mode for x11vnc in that it
1066
will start up and poll virtual X servers!  This can
1067 1068 1069 1070 1071 1072
be used from, say, 
.IR inetd (8)
to provide a means of
definitely getting a desktop (either real or virtual)
on the machine.  E.g. a desktop service:
.IP
1073
5900 stream tcp nowait root /usr/sbin/tcpd /.../x11vnc
1074 1075 1076 1077 1078 1079
\fB-inetd\fR \fB-q\fR \fB-http\fR \fB-ssl\fR SAVE \fB-unixpw\fR \fB-users\fR unixpw=\\
\fB-passwd\fR secret \fB-prog\fR /.../x11vnc \\
\fB-display\fR WAIT:cmd=FINDCREATEDISPLAY
.IP
Where /.../x11vnc is the full path to x11vnc.
.IP
1080 1081 1082 1083
If for some reason you do not want x11vnc to ever
try to find an existing display set the env. var
X11VNC_FINDDISPLAY_ALWAYS_FAILS=1 (also \fB-env\fR ...)
.IP
1084 1085 1086
Use WAIT:cmd=FINDCREATEDISPLAY-print to print out the
script used.  You can specify the preferred order via
e.g., WAIT:cmd=FINDCREATEDISPLAY-Xdummy,Xvfb,X  and/or
1087 1088 1089 1090 1091 1092 1093 1094 1095
leave out ones you do not want.  The the extra case
"X" means try to start up a real, hardware X server
using 
.IR xinit (1)
or 
.IR startx (1).
If there is already an
X server running the X case may only work on Linux
(see 
1096 1097
.IR startx (1)
).
1098
.IP
1099 1100 1101 1102 1103
You can set the environment variable FD_GEOM (or
X11VNC_CREATE_GEOM) to WxH or WxHxD to set the width
and height and optionally the color depth of the
created display.
.IP
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
If you want the FINDCREATEDISPLAY session to contact an
XDMCP login manager (xdm/gdm/kdm) on the same machine,
then use "Xvfb.xdmcp" instead of "Xvfb", etc.
The user will have to supply his username and password
one more time (but he gets to select his desktop type
so that can be useful).  For this to work, you will
need to enable localhost XDMCP (udp port 177) for the
display manager.  This seems to be:
.IP
for gdm in gdm.conf:   Enable=true in section [xdmcp]
for kdm in kdmrc:      Enable=true in section [Xdmcp]
for xdm in xdm-config: DisplayManager.requestPort: 177
1116 1117 1118
.IP
See the shorthand options above "\fB-svc\fR" and "\fB-xdmsvc\fR"
that specify the above options for some useful cases.
1119 1120 1121
.IP
If you set the env. var WAITBG=1 x11vnc will go into
the background once listening in wait mode.
1122 1123 1124 1125 1126 1127
.PP
\fB-nossl\fR
.IP
Disable the \fB-ssl\fR option (see below). Since \fB-ssl\fR is off
by default \fB-nossl\fR would only be used on the commandline
to unset any *earlier* \fB-ssl\fR option (or \fB-svc...)\fR
1128
.PP
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
\fB-ssl\fR \fI[pem]\fR
.IP
Use the openssl library (www.openssl.org) to provide a
built-in encrypted SSL tunnel between VNC viewers and
x11vnc.  This requires libssl support to be compiled
into x11vnc at build time.  If x11vnc is not built
with libssl support it will exit immediately when \fB-ssl\fR
is prescribed.
.IP
[pem] is optional, use "\fB-ssl\fR \fI/path/to/mycert.pem\fR"
to specify a PEM certificate file to use to identify
and provide a key for this server.  See 
.IR openssl (1)
for
more info about PEMs and the \fB-sslGenCert\fR option below.
.IP
The connecting VNC viewer SSL tunnel can optionally
authenticate this server if they have the public
key part of the certificate (or a common certificate
authority, CA, is a more sophisicated way to verify
this server's cert, see \fB-sslGenCA\fR below).  This is
used to prevent man-in-the-middle attacks.  Otherwise,
if the VNC viewer accepts this server's key without
verification, at least the traffic is protected
from passive sniffing on the network (but NOT from
man-in-the-middle attacks).
.IP
If [pem] is not supplied and the 
.IR openssl (1)
utility
command exists in PATH, then a temporary, self-signed
certificate will be generated for this session (this
may take 5-30 seconds on slow machines).  If 
.IR openssl (1)
cannot be used to generate a temporary certificate
x11vnc exits immediately.
.IP
If successful in using 
.IR openssl (1)
to generate a
temporary certificate, the public part of it will be
displayed to stderr (e.g. one could copy it to the
client-side to provide authentication of the server to
VNC viewers.)  See following paragraphs for how to save
keys to reuse when x11vnc is restarted.
.IP
Set the env. var. X11VNC_SHOW_TMP_PEM=1 to have x11vnc
print out the entire certificate, including the PRIVATE
KEY part, to stderr.  One could reuse this cert if saved
in a [pem] file.  Similarly, set X11VNC_KEEP_TMP_PEM=1
to not delete the temporary PEM file: the file name
will be printed to stderr (so one could move it to
a safe place for reuse).  You will be prompted for a
passphrase for the private key.
.IP
If [pem] is "SAVE" then the certificate will be saved
to the file ~/.vnc/certs/server.pem, or if that file
exists it will be used directly.  Similarly, if [pem]
is "SAVE_PROMPT" the server.pem certificate will be
made based on your answers to its prompts for info such
as OrganizationalName, CommonName, etc.
.IP
Use "SAVE-<string>" and "SAVE_PROMPT-<string>"
to refer to the file ~/.vnc/certs/server-<string>.pem
instead.  E.g. "SAVE-charlie" will store to the file
~/.vnc/certs/server-charlie.pem
.IP
See \fB-ssldir\fR below to use a directory besides the
default ~/.vnc/certs
.IP
Example: x11vnc \fB-ssl\fR SAVE \fB-display\fR :0 ...
.IP
Your VNC viewer will also need to be able to connect
via SSL.  See the discussion below under \fB-stunnel\fR and
1203
the FAQ (ss_vncviewer script) for how this might be
1204 1205 1206 1207 1208
achieved.  E.g. on Unix it is easy to write a shell
script that starts up stunnel and then vncviewer.
Also in the x11vnc source a SSL enabled Java VNC Viewer
applet is provided in the classes/ssl directory.
.PP
1209 1210 1211 1212 1213 1214 1215 1216 1217
\fB-ssltimeout\fR \fIn\fR
.IP
Set SSL read timeout to n seconds.  In some situations
(i.e. an iconified viewer in Windows) the viewer stops
talking and the connection is dropped after the default
timeout (25s for about the first minute, 43200s later).
Set to zero to poll forever.  Set to a negative value
to use the builtin setting.
.PP
1218 1219 1220 1221 1222 1223 1224
\fB-sslnofail\fR
.IP
Exit at the first SSL connection failure. Useful when
scripting SSL connections (e.g. x11vnc is started via
ssh) and you do not want x11vnc waiting around for more
connections, tying up ports, etc.
.PP
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
\fB-ssldir\fR \fI[dir]\fR
.IP
Use [dir] as an alternate ssl certificate and key
management toplevel directory.  The default is
~/.vnc/certs
.IP
This directory is used to store server and other
certificates and keys and also other materials.  E.g. in
the simplest case, "\fB-ssl\fR \fISAVE\fR" will store the x11vnc
server cert in [dir]/server.pem
.IP
Use of alternate directories via \fB-ssldir\fR allows you to
manage multiple VNC Certificate Authority (CA) keys.
Another use is if ~/.vnc/cert is on an NFS share you
might want your certificates and keys to be on a local
filesystem to prevent network snooping (for example
\fB-ssldir\fR /var/lib/x11vnc-certs).
.IP
\fB-ssldir\fR affects nearly all of the other \fB-ssl*\fR options,
e.g. \fB-ssl\fR SAVE, \fB-sslGenCert,\fR etc..
.PP
\fB-sslverify\fR \fI[path]\fR
.IP
For either of the \fB-ssl\fR or \fB-stunnel\fR modes, use [path]
to provide certificates to authenticate incoming VNC
*Client* connections (normally only the server is
authenticated in SSL.)  This can be used as a method
to replace standard password authentication of clients.
.IP
If [path] is a directory it contains the client (or CA)
certificates in separate files.  If [path] is a file,
it contains multiple certificates.  See special tokens
below.  These correspond to the "CApath = dir" and
"CAfile = file" stunnel options.  See the 
.IR stunnel (8)
manpage for details.
.IP
Examples:
1263
x11vnc \fB-ssl\fR \fB-sslverify\fR ~/my.crt
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
x11vnc \fB-ssl\fR \fB-sslverify\fR ~/my_pem_dir/
.IP
Note that if [path] is a directory, it must contain
the certs in separate files named like <HASH>.0, where
the value of <HASH> is found by running the command
"openssl x509 \fB-hash\fR \fB-noout\fR \fB-in\fR file.crt". Evidently
one uses <HASH>.1 if there is a collision...
.IP
The the key-management utility "\fB-sslCertInfo\fR \fIHASHON\fR"
and "\fB-sslCertInfo\fR \fIHASHOFF\fR" will create/delete these
hashes for you automatically (via symlink) in the HASH
subdirs it manages.  Then you can point \fB-sslverify\fR to
the HASH subdir.
.IP
Special tokens: in \fB-ssl\fR mode, if [path] is not a file or
a directory, it is taken as a comma separated list of
tokens that are interpreted as follows:
.IP
If a token is "CA" that means load the CA/cacert.pem
file from the ssl directory.  If a token is "clients"
then all the files clients/*.crt in the ssl directory
are loaded.  Otherwise the file clients/token.crt
is attempted to be loaded.  As a kludge, use a token
like ../server-foo to load a server cert if you find
that necessary.
.IP
Use \fB-ssldir\fR to use a directory different from the
~/.vnc/certs default.
.IP
Note that if the "CA" cert is loaded you do not need
to load any of the certs that have been signed by it.
You will need to load any additional self-signed certs
however.
.IP
Examples:
x11vnc \fB-ssl\fR \fB-sslverify\fR CA
x11vnc \fB-ssl\fR \fB-sslverify\fR self:fred,self:jim
x11vnc \fB-ssl\fR \fB-sslverify\fR CA,clients
.IP
Usually "\fB-sslverify\fR \fICA\fR" is the most effective.
See the \fB-sslGenCA\fR and \fB-sslGenCert\fR options below for
how to set up and manage the CA framework.
.IP
NOTE: the following utilities, \fB-sslGenCA,\fR \fB-sslGenCert,\fR
\fB-sslEncKey,\fR and \fB-sslCertInfo\fR are provided for
completeness, but for casual usage they are overkill.
.IP
They provide VNC Certificate Authority (CA) key creation
and server / client key generation and signing.  So they
provide a basic Public Key management framework for
VNC-ing with x11vnc. (note that they require 
.IR openssl (1)
be installed on the system)
.IP
However, the simplest usage mode (where x11vnc
automatically generates its own, self-signed, temporary
key and the VNC viewers always accept it, e.g. accepting
via a dialog box) is probably safe enough for most
scenarios.  CA management is not needed.
.IP
To protect against Man-In-The-Middle attacks the
simplest mode can be improved by using "\fB-ssl\fR \fISAVE\fR"
to have x11vnc create a longer term self-signed
certificate, and then (safely) copy the corresponding
public key cert to the desired client machines (care
must be taken the private key part is not stolen;
you will be prompted for a passphrase).
.IP
So keep in mind no CA key creation or management
(-sslGenCA and \fB-sslGenCert)\fR is needed for either of
the above two common usage modes.
.IP
One might want to use \fB-sslGenCA\fR and \fB-sslGenCert\fR
if you had a large number of VNC client and server
workstations.  That way the administrator could generate
a single CA key with \fB-sslGenCA\fR and distribute its
certificate part to all of the workstations.
.IP
Next, he could create signed VNC server keys
(-sslGenCert server ...) for each workstation or user
that then x11vnc would use to authenticate itself to
any VNC client that has the CA cert.
.IP
Optionally, the admin could also make it so the
VNC clients themselves are authenticated to x11vnc
(-sslGenCert client ...)  For this \fB-sslverify\fR would be
pointed to the CA cert (and/or self-signed certs).
.IP
x11vnc will be able to use all of these cert and
key files.  On the VNC client side, they will need to
be "imported" somehow.  Web browsers have "Manage
Certificates" actions as does the Java applet plugin
Control Panel.  stunnel can also use these files (see
1357
the ss_vncviewer example script in the FAQ.)
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
.PP
\fB-sslGenCA\fR \fI[dir]\fR
.IP
Generate your own Certificate Authority private key,
certificate, and other files in directory [dir].
.IP
If [dir] is not supplied, a \fB-ssldir\fR setting is used,
or otherwise ~/.vnc/certs is used.
.IP
This command also creates directories where server and
client certs and keys will be stored.  The 
.IR openssl (1)
program must be installed on the system and available
in PATH.
.IP
After the CA files and directories are created the
command exits; the VNC server is not run.
.IP
You will be prompted for information to put into the CA
certificate.  The info does not have to be accurate just
as long as clients accept the cert for VNC connections.
You will also need to supply a passphrase of at least
4 characters for the CA private key.
.IP
Once you have generated the CA you can distribute
its certificate part, [dir]/CA/cacert.pem, to other
workstations where VNC viewers will be run.  One will
need to "import" this certicate in the applications,
e.g. Web browser, Java applet plugin, stunnel, etc.
Next, you can create and sign keys using the CA with
the \fB-sslGenCert\fR option below.
.IP
Examples:
x11vnc \fB-sslGenCA\fR
x11vnc \fB-sslGenCA\fR  ~/myCAdir
x11vnc \fB-ssldir\fR ~/myCAdir \fB-sslGenCA\fR
.IP
(the last two lines are equivalent)
.PP
\fB-sslGenCert\fR \fItype\fR \fIname\fR
.IP
Generate a VNC server or client certificate and private
key pair signed by the CA created previously with
\fB-sslGenCA.\fR  The 
.IR openssl (1)
program must be installed
on the system and available in PATH.
.IP
After the Certificate is generated the command exits;
the VNC server is not run.
.IP
The type of key to be generated is the string \fItype\fR.
It is either "server" (i.e. for use by x11vnc) or
"client" (for a VNC viewer).  Note that typically
only "server" is used: the VNC clients authenticate
themselves by a non-public-key method (e.g. VNC or
unix password).  \fItype\fR is required.
.IP
An arbitrary default name you want to associate with
the key is supplied by the \fIname\fR string.  You can
change it at the various prompts when creating the key.
\fIname\fR is optional.
.IP
If name is left blank for clients keys then "nobody"
is used.  If left blank for server keys, then the
primary server key: "server.pem" is created (this
is the saved one referenced by "\fB-ssl\fR \fISAVE\fR" when the
server is started)
.IP
If \fIname\fR begins with the string "self:" then
a self-signed certificate is created instead of one
signed by your CA key.
.IP
If \fIname\fR begins with the string "req:" then only a
key (.key) and a certificate signing *request* (.req)
are generated.  You can then send the .req file to
an external CA (even a professional one, e.g. Thawte)
and then combine the .key and the received cert into
the .pem file with the same basename.
.IP
The distinction between "server" and "client" is
simply the choice of output filenames and sub-directory.
This makes it so the \fB-ssl\fR SAVE-name option can easily
pick up the x11vnc PEM file this option generates.
And similarly makes it easy for the \fB-sslverify\fR option
to pick up your client certs.
.IP
There is nothing special about the filename or directory
location of either the "server" and "client" certs.
You can rename the files or move them to wherever
you like.
.IP
Precede this option with \fB-ssldir\fR [dir] to use a
directory other than the default ~/.vnc/certs You will
need to run \fB-sslGenCA\fR on that directory first before
doing any \fB-sslGenCert\fR key creation.
.IP
Note you cannot recreate a cert with exactly the same
distiguished name (DN) as an existing one.  To do so,
you will need to edit the [dir]/CA/index.txt file to
delete the line.
.IP
Similar to \fB-sslGenCA,\fR you will be prompted to fill
in some information that will be recorded in the
certificate when it is created.  Tip: if you know
the fully-quailified hostname other people will be
connecting to you can use that as the CommonName "CN"
to avoid some applications (e.g. web browsers and java
plugin) complaining it does not match the hostname.
.IP
You will also need to supply the CA private key
passphrase to unlock the private key created from
\fB-sslGenCA.\fR  This private key is used to sign the server
or client certicate.
.IP
The "server" certs can be used by x11vnc directly by
pointing to them via the \fB-ssl\fR [pem] option.  The default
file will be ~/.vnc/certs/server.pem.  This one would
be used by simply typing \fB-ssl\fR SAVE.  The pem file
contains both the certificate and the private key.
server.crt file contains the cert only.
.IP
The "client" cert + private key file will need
to be copied and imported into the VNC viewer
side applications (Web browser, Java plugin,
stunnel, etc.)  Once that is done you can delete the
"client" private key file on this machine since
it is only needed on the VNC viewer side.  The,
e.g. ~/.vnc/certs/clients/<name>.pem contains both
the cert and private key.  The <name>.crt contains the
certificate only.
.IP
NOTE: It is very important to know one should always
generate new keys with a passphrase.  Otherwise if an
untrusted user steals the key file he could use it to
masquerade as the x11vnc server (or VNC viewer client).
You will be prompted whether to encrypt the key with
a passphrase or not.  It is recommended that you do.
One inconvenience to a passphrase is that it must
be suppled every time x11vnc or the client app is
started up.
.IP
Examples:
.IP
x11vnc \fB-sslGenCert\fR server
x11vnc \fB-ssl\fR SAVE \fB-display\fR :0 ...
.IP
1505
and then on viewer using ss_vncviewer stunnel wrapper
1506
(see the FAQ):
1507
ss_vncviewer \fB-verify\fR ./cacert.crt hostname:0
1508 1509 1510
.IP
(this assumes the cacert.crt cert from \fB-sslGenCA\fR
was safely copied to the VNC viewer machine where
1511
ss_vncviewer is run)
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
.IP
Example using a name:
.IP
x11vnc \fB-sslGenCert\fR server charlie
x11vnc \fB-ssl\fR SAVE-charlie \fB-display\fR :0 ...
.IP
Example for a client certificate (rarely used):
.IP
x11vnc \fB-sslGenCert\fR client roger
scp ~/.vnc/certs/clients/roger.pem somehost:.
rm  ~/.vnc/certs/clients/roger.pem
.IP
x11vnc is then started with the the option \fB-sslverify\fR
~/.vnc/certs/clients/roger.crt (or simply \fB-sslverify\fR
roger), and on the viewer user on somehost could do
for example:
.IP
1529
ss_vncviewer \fB-mycert\fR ./roger.pem hostname:0
1530 1531 1532 1533 1534 1535 1536
.IP
If you set the env. var REQ_ARGS='...' it will be
passed to openssl 
.IR req (1).
A common use would be
REQ_ARGS='-days 730' to bump up the expiration date
(2 years in this case).
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673
.PP
\fB-sslEncKey\fR \fI[pem]\fR
.IP
Utility to encrypt an existing PEM file with a
passphrase you supply when prompted.  For that key to be
used (e.g. by x11vnc) the passphrase must be supplied
each time.
.IP
The "SAVE" notation described under \fB-ssl\fR applies as
well. (precede this option with \fB-ssldir\fR [dir] to refer
a directory besides the default ~/.vnc/certs)
.IP
The 
.IR openssl (1)
program must be installed on the system
and available in PATH.  After the Key file is encrypted
the command exits; the VNC server is not run.
.IP
Examples:
x11vnc \fB-sslEncKey\fR /path/to/foo.pem
x11vnc \fB-sslEncKey\fR SAVE
x11vnc \fB-sslEncKey\fR SAVE-charlie
.PP
\fB-sslCertInfo\fR \fI[pem]\fR
.IP
Prints out information about an existing PEM file.
In addition the public certificate is also printed.
The 
.IR openssl (1)
program must be in PATH. Basically the
command "openssl x509 \fB-text"\fR is run on the pem.
.IP
The "SAVE" notation described under \fB-ssl\fR applies
as well.
.IP
Using  "LIST" will give a list of all certs being
managed (in the ~/.vnc/certs dir, use \fB-ssldir\fR to refer
to another dir).  "ALL" will print out the info for
every managed key (this can be very long).  Giving a
client or server cert shortname will also try a lookup
(e.g. \fB-sslCertInfo\fR charlie).  Use "LISTL" or "LL"
for a long (ls \fB-l\fR style) listing.
.IP
Using "HASHON" will create subdirs [dir]/HASH and
[dir]/HASH with OpenSSL hash filenames (e.g. 0d5fbbf1.0)
symlinks pointing up to the corresponding *.crt file.
([dir] is ~/.vnc/certs or one given by \fB-ssldir.)\fR
This is a useful way for other OpenSSL applications
(e.g. stunnel) to access all of the certs without
having to concatenate them.  x11vnc will not use them
unless you specifically reference them.  "HASHOFF"
removes these HASH subdirs.
.IP
The LIST, LISTL, LL, ALL, HASHON, HASHOFF words can
also be lowercase, e.g. "list".
.PP
\fB-sslDelCert\fR \fI[pem]\fR
.IP
Prompts you to delete all .crt .pem .key .req files
associated with [pem].  "SAVE" and lookups as in
\fB-sslCertInfo\fR apply as well.
.PP
\fB-stunnel\fR \fI[pem]\fR
.IP
Use the 
.IR stunnel (8)
(www.stunnel.org) to provide an
encrypted SSL tunnel between viewers and x11vnc.
.IP
This external tunnel method was implemented prior to the
integrated \fB-ssl\fR encryption described above.  It still
works well.  This requires stunnel to be installed
on the system and available via PATH (n.b. stunnel is
often installed in sbin directories).  Version 4.x of
stunnel is assumed (but see \fB-stunnel3\fR below.)
.IP
[pem] is optional, use "\fB-stunnel\fR \fI/path/to/stunnel.pem\fR"
to specify a PEM certificate file to pass to stunnel.
Whether one is needed or not depends on your stunnel
configuration.  stunnel often generates one at install
time.  See the stunnel documentation for details.
.IP
stunnel is started up as a child process of x11vnc and
any SSL connections stunnel receives are decrypted and
sent to x11vnc over a local socket.  The strings
"The SSL VNC desktop is ..." and "SSLPORT=..."
are printed out at startup to indicate this.
.IP
The \fB-localhost\fR option is enforced by default
to avoid people routing around the SSL channel.
Set STUNNEL_DISABLE_LOCALHOST=1 before starting x11vnc
to disable the requirement.
.IP
Your VNC viewer will also need to be able to connect via
SSL.  Unfortunately not too many do this.  UltraVNC has
an encryption plugin but it does not seem to be SSL.
.IP
Also, in the x11vnc distribution, a patched TightVNC
Java applet is provided in classes/ssl that does SSL
connections (only).
.IP
It is also not too difficult to set up an stunnel or
other SSL tunnel on the viewer side.  A simple example
on Unix using stunnel 3.x is:
.IP
% stunnel \fB-c\fR \fB-d\fR localhost:5901 \fB-r\fR remotehost:5900
% vncviewer localhost:1
.IP
For Windows, stunnel has been ported to it and there
are probably other such tools available.  See the FAQ
for more examples.
.PP
\fB-stunnel3\fR \fI[pem]\fR
.IP
Use version 3.x stunnel command line syntax instead of
version 4.x
.PP
\fB-https\fR \fI[port]\fR
.IP
Choose a separate HTTPS port (-ssl mode only).
.IP
In \fB-ssl\fR mode, it turns out you can use the
single VNC port (e.g. 5900) for both VNC and HTTPS
connections. (HTTPS is used to retrieve a SSL-aware
VncViewer.jar applet that is provided with x11vnc).
Since both use SSL the implementation was extended to
detect if HTTP traffic (i.e. GET) is taking place and
handle it accordingly.  The URL would be, e.g.:
.IP
https://mymachine.org:5900/
.IP
This is convenient for firewalls, etc, because only one
port needs to be allowed in.  However, this heuristic
adds a few seconds delay to each connection and can be
unreliable (especially if the user takes much time to
ponder the Certificate dialogs in his browser, Java VM,
or VNC Viewer applet.  That's right 3 separate "Are
1674
you sure you want to connect?" dialogs!)
1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
.IP
So use the \fB-https\fR option to provide a separate, more
reliable HTTPS port that x11vnc will listen on.  If
[port] is not provided (or is 0), one is autoselected.
The URL to use is printed out at startup.
.IP
The SSL Java applet directory is specified via the
\fB-httpdir\fR option.  If not supplied it will try to guess
the directory as though the \fB-http\fR option was supplied.
.PP
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
\fB-httpsredir\fR \fI[port]\fR
.IP
In \fB-ssl\fR mode with the Java applet retrieved via HTTPS:
when the HTML file containing applet parameters
('index.vnc' or 'proxy.vnc') is sent do not set the
applet PORT parameter to the actual VNC port but set it
to "port" instead.  If "port" is not supplied, then
the port number is guessed from the Host: HTTP header.
.IP
This is useful when an incoming TCP connection
redirection is performed by a router/gateway/firewall
from one port to an internal machine where x11vnc is
listening on a different port. The Java applet needs to
connect to the firewall/router port, not the VNC port
on the internal workstation. For example, one could
redir from mygateway.com:443 to workstation:5900.
.IP
This spares the user from having to type in
https://mygateway.com/?PORT=443 into their web browser
(note 443 is the default https port; other ports must
be explicity indicated: https://mygateway.com:8000/...)
.PP
1707
\fB-usepw\fR
1708
.IP
1709 1710 1711 1712 1713 1714 1715
If no other password method was supplied on the command
line, first look for ~/.vnc/passwd and if found use it
with \fB-rfbauth;\fR next, look for ~/.vnc/passwdfile and
use it with \fB-passwdfile;\fR otherwise, prompt the user
for a password to create ~/.vnc/passwd and use it with
the \fB-rfbauth\fR option.  If none of these succeed x11vnc
exits immediately.
1716 1717 1718 1719 1720
.PP
\fB-storepasswd\fR \fIpass\fR \fIfile\fR
.IP
Store password \fIpass\fR as the VNC password in the
file \fIfile\fR.  Once the password is stored the
1721
program exits.  Use the password via "\fB-rfbauth\fR \fIfile\fR"
1722
.IP
1723
If called with no arguments, "x11vnc \fB-storepasswd",\fR
1724
the user is prompted for a password and it is stored
1725 1726
in the file ~/.vnc/passwd.  Called with one argument,
that will be the file to store the prompted password in.
1727 1728 1729 1730 1731
.PP
\fB-nopw\fR
.IP
Disable the big warning message when you use x11vnc
without some sort of password.
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
.PP
\fB-accept\fR \fIstring\fR
.IP
Run a command (possibly to prompt the user at the
X11 display) to decide whether an incoming client
should be allowed to connect or not.  \fIstring\fR is
an external command run via 
.IR system (3)
or some special
cases described below.  Be sure to quote \fIstring\fR
1742 1743 1744 1745
if it contains spaces, shell characters, etc.  If the
external command returns 0 the client is accepted,
otherwise the client is rejected.  See below for an
extension to accept a client view-only.
1746
.IP
1747
If x11vnc is running as root (say from 
1748
.IR inetd (8)
1749 1750 1751 1752 1753 1754 1755 1756 1757
or from
display managers 
.IR xdm (1)
, 
.IR gdm (1)
, etc), think about the
security implications carefully before supplying this
option (likewise for the \fB-gone\fR option).
.IP
1758 1759 1760 1761 1762 1763 1764 1765
Environment: The RFB_CLIENT_IP environment variable will
be set to the incoming client IP number and the port
in RFB_CLIENT_PORT (or -1 if unavailable).  Similarly,
RFB_SERVER_IP and RFB_SERVER_PORT (the x11vnc side
of the connection), are set to allow identification
of the tcp virtual circuit.  The x11vnc process
id will be in RFB_X11VNC_PID, a client id number in
RFB_CLIENT_ID, and the number of other connected clients
runge's avatar
runge committed
1766 1767 1768 1769 1770 1771 1772
in RFB_CLIENT_COUNT.  RFB_MODE will be "accept".
RFB_STATE will be PROTOCOL_VERSION, SECURITY_TYPE,
AUTHENTICATION, INITIALISATION, NORMAL, or UNKNOWN
indicating up to which state the client has acheived.
RFB_LOGIN_VIEWONLY will be 0, 1, or -1 (unknown).
RFB_USERNAME, RFB_LOGIN_TIME, and RFB_CURRENT_TIME may
also be set.
1773 1774 1775 1776
.IP
If \fIstring\fR is "popup" then a builtin popup window
is used.  The popup will time out after 120 seconds,
use "popup:N" to modify the timeout to N seconds
1777
(use 0 for no timeout).
1778
.IP
1779 1780 1781 1782 1783 1784 1785 1786 1787
In the case of "popup" and when the \fB-unixpw\fR option
is specified, then a *second* window will be popped
up after the user successfully logs in via his UNIX
password.  This time the user will be identified as
UNIX:username@hostname, the "UNIX:" prefix indicates
which user the viewer logged as via \fB-unixpw.\fR  The first
popup is only for whether to allow him to even *try*
to login via unix password.
.IP
1788 1789
If \fIstring\fR is "xmessage" then an 
.IR xmessage (1)
1790 1791
invocation is used for the command.  xmessage must be
installed on the machine for this to work.
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
.IP
Both "popup" and "xmessage" will present an option
for accepting the client "View-Only" (the client
can only watch).  This option will not be presented if
\fB-viewonly\fR has been specified, in which case the entire
display is view only.
.IP
If the user supplied command is prefixed with something
like "yes:0,no:*,view:3 mycommand ..." then this
associates the numerical command return code with
the actions: accept, reject, and accept-view-only,
respectively.  Use "*" instead of a number to indicate
the default action (in case the command returns an
unexpected value).  E.g. "no:*" is a good choice.
.IP
1807
Note that x11vnc blocks while the external command
1808
or popup is running (other clients may see no updates
1809 1810 1811
during this period).  So a person sitting a the physical
display is needed to respond to an popup prompt. (use
a 2nd x11vnc if you lock yourself out).
1812 1813 1814
.IP
More \fB-accept\fR tricks: use "popupmouse" to only allow
mouse clicks in the builtin popup to be recognized.
1815 1816 1817 1818
Similarly use "popupkey" to only recognize
keystroke responses.  These are to help avoid the
user accidentally accepting a client by typing or
clicking. All 3 of the popup keywords can be followed
1819 1820 1821
by +N+M to supply a position for the popup window.
The default is to center the popup window.
.PP
runge's avatar
runge committed
1822 1823 1824 1825 1826 1827 1828 1829 1830
\fB-afteraccept\fR \fIstring\fR
.IP
As \fB-accept,\fR except to run a user supplied command after
a client has been accepted and authenticated. RFB_MODE
will be set to "afteraccept" and the other RFB_*
variables are as in \fB-accept.\fR  Unlike \fB-accept,\fR the
command return code is not interpreted by x11vnc.
Example: \fB-afteraccept\fR 'killall xlock &'
.PP
1831 1832 1833
\fB-gone\fR \fIstring\fR
.IP
As \fB-accept,\fR except to run a user supplied command when
1834 1835
a client goes away (disconnects).  RFB_MODE will be
set to "gone" and the other RFB_* variables are as
1836 1837 1838
in \fB-accept.\fR  The "popup" actions apply as well.
Unlike \fB-accept,\fR the command return code is not
interpreted by x11vnc.  Example: \fB-gone\fR 'xlock &'
1839
.PP
1840 1841 1842
\fB-users\fR \fIlist\fR
.IP
If x11vnc is started as root (say from 
1843
.IR inetd (8)
1844 1845
or from
display managers 
1846 1847 1848
.IR xdm (1)
, 
.IR gdm (1)
1849 1850
, etc), then as soon
as possible after connections to the X display are
1851 1852 1853 1854
established try to switch to one of the users in the
comma separated \fIlist\fR.  If x11vnc is not running as
root this option is ignored.
.IP
1855 1856 1857 1858 1859 1860
Why use this option?  In general it is not needed since
x11vnc is already connected to the X display and can
perform its primary functions.  The option was added
to make some of the *external* utility commands x11vnc
occasionally runs work properly.  In particular under
GNOME and KDE to implement the "\fB-solid\fR \fIcolor\fR" feature
1861 1862 1863 1864 1865
external commands (gconftool-2 and dcop) unfortunately
must be run as the user owning the desktop session.
Since this option switches userid it also affects the
userid used to run the processes for the \fB-accept\fR and
\fB-gone\fR options.  It also affects the ability to read
1866 1867 1868 1869
files for options such as \fB-connect,\fR \fB-allow,\fR and \fB-remap\fR
and also the ultra and tight filetransfer feature if
enabled.  Note that the \fB-connect\fR file is also sometimes
written to.
1870 1871
.IP
So be careful with this option since in some situations
1872 1873
its use can decrease security.
.IP
1874 1875 1876
In general the switch to a user will only take place
if the display can still be successfully opened as that
user (this is primarily to try to guess the actual owner
1877
of the session). Example: "\fB-users\fR \fIfred,wilma,betty\fR".
1878 1879 1880 1881
Note that a malicious local user "barney" by
quickly using "xhost +" when logging in may possibly
get the x11vnc process to switch to user "fred".
What happens next?
1882 1883
.IP
Under display managers it may be a long time before
1884 1885
the switch succeeds (i.e. a user logs in).  To instead
make it switch immediately regardless if the display
1886
can be reopened prefix the username with the "+"
1887
character. E.g. "\fB-users\fR \fI+bob\fR" or "\fB-users\fR \fI+nobody\fR".
1888
.IP
1889
The latter (i.e. switching immediately to user
runge's avatar
runge committed
1890
"nobody") is the only obvious use of the \fB-users\fR option
1891 1892
that increases security.
.IP
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
Use the following notation to associate a group with
a user: user1.group1,user2.group2,...  Note that
.IR initgroups (2)
will still be called first to try to
switch to ALL of a user's groups (primary and additional
groups).  Only if that fails or it is not available
then the single group specified as above (or the user's
primary group if not specified) is switched to with
.IR setgid (2).
Use \fB-env\fR X11VNC_SINGLE_GROUP=1 to prevent
trying 
.IR initgroups (2)
and only switch to the single
group.  This sort of setting is only really needed to
make the ultra or tight filetransfer permissions work
properly. This format applies to any comma separated list
of users, even the special "=" modes described below.
.IP
1911 1912 1913 1914 1915 1916
In \fB-unixpw\fR mode, if "\fB-users\fR \fIunixpw=\fR" is supplied
then after a user authenticates himself via the
\fB-unixpw\fR mechanism, x11vnc will try to switch to that
user as though "\fB-users\fR \fI+username\fR" had been supplied.
If you want to limit which users this will be done for,
provide them as a comma separated list after "unixpw="
1917
Groups can also be specified as described above.
1918
.IP
1919 1920 1921 1922
Similarly, in \fB-ssl\fR mode, if "\fB-users\fR \fIsslpeer=\fR" is
supplied then after an SSL client authenticates with his
cert (the \fB-sslverify\fR option is required for this) x11vnc
will extract a UNIX username from the "emailAddress"
1923
field (username@hostname.com) of the "Subject" of the
1924 1925 1926 1927 1928 1929
x509 SSL cert and then try to switch to that user as
though "\fB-users\fR \fI+username\fR" had been supplied.  If you
want to limit which users this will be done for, provide
them as a comma separated list after "sslpeer=".
Set the env. var X11VNC_SSLPEER_CN to use the Common
Name (normally a hostname) instead of the Email field.
1930 1931 1932 1933 1934 1935
.IP
NOTE: for sslpeer= mode the x11vnc administrator must
take care that any client certs he adds to \fB-sslverify\fR
have the intended UNIX username in the "emailAddress"
field of the cert.  Otherwise a user may be able to
log in as another.  This command can be of use in
1936 1937 1938 1939 1940 1941
checking: "openssl x509 \fB-text\fR \fB-in\fR file.crt", see the
"Subject:" line.  Also, along with the normal RFB_*
env. vars. (see \fB-accept)\fR passed to external cmd=
commands, RFB_SSL_CLIENT_CERT will be set to the
client's x509 certificate string.
.IP
1942 1943 1944
The sslpeer= mode can aid finding X sessions via the
FINDDISPLAY and FINDCREATEDISPLAY mechanisms.
.IP
1945 1946 1947
To immediately switch to a user *before* connections
to the X display are made or any files opened use the
"=" character: "\fB-users\fR \fI=bob\fR".  That user needs to
1948
be able to open the X display and any files of course.
1949 1950 1951 1952 1953 1954 1955 1956 1957
.IP
The special user "guess=" means to examine the utmpx
database (see 
.IR who (1)
) looking for a user attached to
the display number (from DISPLAY or \fB-display\fR option)
and try him/her.  To limit the list of guesses, use:
"\fB-users\fR \fIguess=bob,betty\fR".
.IP
1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
Even more sinister is the special user "lurk="
that means to try to guess the DISPLAY from the utmpx
login database as well.  So it "lurks" waiting for
anyone to log into an X session and then connects to it.
Specify a list of users after the = to limit which users
will be tried.  To enable a different searching mode, if
the first user in the list is something like ":0" or
":0-2" that indicates a range of DISPLAY numbers that
will be tried (regardless of whether they are in the
utmpx database) for all users that are logged in.  Also
see the "\fB-display\fR \fIWAIT:...\fR" functionality.  Examples:
"\fB-users\fR \fIlurk=\fR" and also "\fB-users\fR \fIlurk=:0-1,bob,mary\fR"
1970 1971 1972 1973
.IP
Be especially careful using the "guess=" and "lurk="
modes.  They are not recommended for use on machines
with untrustworthy local users.
1974
.PP
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
\fB-noshm\fR
.IP
Do not use the MIT-SHM extension for the polling.
Remote displays can be polled this way: be careful this
can use large amounts of network bandwidth.  This is
also of use if the local machine has a limited number
of shm segments and \fB-onetile\fR is not sufficient.
.PP
\fB-flipbyteorder\fR
.IP
Sometimes needed if remotely polled host has different
endianness.  Ignored unless \fB-noshm\fR is set.
.PP
\fB-onetile\fR
.IP
Do not use the new copy_tiles() framebuffer mechanism,
1991 1992
just use 1 shm tile for polling.  Limits shm segments
used to 3.
1993
.PP
1994 1995 1996 1997 1998 1999
\fB-solid\fR \fI[color]\fR
.IP
To improve performance, when VNC clients are connected
try to change the desktop background to a solid color.
The [color] is optional: the default color is "cyan4".
For a different one specify the X color (rgb.txt name,
2000 2001
e.g. "darkblue" or numerical "#RRGGBB").
.IP
2002 2003 2004
Currently this option only works on GNOME, KDE, CDE,
and classic X (i.e. with the background image on the
root window).  The "gconftool-2" and "dcop" external
2005
commands are run for GNOME and KDE respectively.
2006
Other desktops won't work, e.g. Xfce (send us the
2007 2008
corresponding commands if you find them).  If x11vnc is
running as root (
2009
.IR inetd (8)
2010 2011
or 
.IR gdm (1)
2012 2013 2014 2015
), the \fB-users\fR option
may be needed for GNOME and KDE.  If x11vnc guesses
your desktop incorrectly, you can force it by prefixing
color with "gnome:", "kde:", "cde:" or "root:".
2016
.PP
2017 2018 2019 2020
\fB-blackout\fR \fIstring\fR
.IP
Black out rectangles on the screen. \fIstring\fR is a
comma separated list of WxH+X+Y type geometries for
2021 2022 2023
each rectangle.  If one of the items on the list is the
string "noptr" the mouse pointer will not be allowed
to go into a blacked out region.
2024
.PP
2025
\fB-xinerama,\fR \fB-noxinerama\fR
2026 2027 2028
.IP
If your screen is composed of multiple monitors
glued together via XINERAMA, and that screen is
2029
not a rectangle this option will try to guess the
2030
areas to black out (if your system has libXinerama).
2031
default: \fB-xinerama\fR
2032
.IP
2033 2034 2035 2036
In general, we have noticed on XINERAMA displays you may
need to use the "\fB-xwarppointer\fR" option if the mouse
pointer misbehaves and it is enabled by default. Use
"\fB-noxwarppointer\fR" if you do not want this.
2037
.PP
2038 2039 2040 2041 2042 2043 2044 2045 2046
\fB-xtrap\fR
.IP
Use the DEC-XTRAP extension for keystroke and mouse
input insertion.  For use on legacy systems, e.g. X11R5,
running an incomplete or missing XTEST extension.
By default DEC-XTRAP will be used if XTEST server grab
control is missing, use \fB-xtrap\fR to do the keystroke and
mouse insertion via DEC-XTRAP as well.
.PP
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
\fB-xrandr\fR \fI[mode]\fR
.IP
If the display supports the XRANDR (X Resize, Rotate
and Reflection) extension, and you expect XRANDR events
to occur to the display while x11vnc is running, this
options indicates x11vnc should try to respond to
them (as opposed to simply crashing by assuming the
old screen size).  See the 
.IR xrandr (1)
manpage and run
\'xrandr \fB-q'\fR for more info.  [mode] is optional and
described below.
.IP
2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
Since watching for XRANDR events and trapping errors
increases polling overhead, only use this option if
XRANDR changes are expected.  For example on a rotatable
screen PDA or laptop, or using a XRANDR-aware Desktop
where you resize often.  It is best to be viewing with a
vncviewer that supports the NewFBSize encoding, since it
knows how to react to screen size changes.  Otherwise,
libvncserver tries to do so something reasonable for
viewers that cannot do this (portions of the screen
may be clipped, unused, etc).
2070 2071 2072 2073 2074 2075 2076 2077 2078
.IP
"mode" defaults to "resize", which means create a
new, resized, framebuffer and hope all viewers can cope
with the change.  "newfbsize" means first disconnect
all viewers that do not support the NewFBSize VNC
encoding, and then resize the framebuffer.  "exit"
means disconnect all viewer clients, and then terminate
x11vnc.
.PP
runge's avatar
runge committed
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
\fB-rotate\fR \fIstring\fR
.IP
Rotate and/or flip the framebuffer view exported by VNC.
This transformation is independent of XRANDR and is
done in software in main memory and so may be slower.
This mode could be useful on a handheld with portrait or
landscape modes that do not correspond to the scanline
order of the actual framebuffer.  \fIstring\fR can be:
.IP
x     flip along x-axis
y     flip along y-axis
xy     flip along x- and y-axes
+90     rotate 90 degrees clockwise
\fB-90\fR     rotate 90 degrees counter-clockwise
+90x     rotate 90 degrees CW, then flip along x
+90y     rotate 90 degrees CW, then flip along y
.IP
these give all possible rotations and reflections.
.IP
Aliases: same as xy:  yx, +180, \fB-180,\fR 180
same as \fB-90:\fR +270, 270
same as +90: 90, (ditto for 90x, 90y)
.IP
Like \fB-scale,\fR this transformation is applied at the very
end of any chain of framebuffer transformations and so
any options with geometries, e.g. \fB-blackout,\fR \fB-clip,\fR etc.
are relative to the original X (or \fB-rawfb)\fR framebuffer,
not the final one sent to VNC viewers.
.IP
If you do not want the cursor shape to be rotated
prefix \fIstring\fR with "nc:", e.g. "nc:+90",
"nc:xy", etc.
.PP
2112 2113 2114 2115 2116 2117 2118 2119 2120
\fB-padgeom\fR \fIWxH\fR
.IP
Whenever a new vncviewer connects, the framebuffer is
replaced with a fake, solid black one of geometry WxH.
Shortly afterwards the framebuffer is replaced with the
real one.  This is intended for use with vncviewers
that do not support NewFBSize and one wants to make
sure the initial viewer geometry will be big enough
to handle all subsequent resizes (e.g. under \fB-xrandr,\fR
2121
\fB-remote\fR id:windowid, rescaling, etc.)
2122
.PP
2123 2124 2125
\fB-o\fR \fIlogfile\fR
.IP
Write stderr messages to file \fIlogfile\fR instead of
2126 2127
to the terminal.  Same as "\fB-logfile\fR \fIfile\fR".  To append
to the file use "\fB-oa\fR \fIfile\fR" or "\fB-logappend\fR \fIfile\fR".
2128
.PP
2129 2130 2131 2132 2133 2134
\fB-flag\fR \fIfile\fR
.IP
Write the "PORT=NNNN" (e.g. PORT=5900) string to
\fIfile\fR in addition to stdout.  This option could be
useful by wrapper script to detect when x11vnc is ready.
.PP
2135 2136 2137 2138 2139 2140 2141 2142
\fB-rc\fR \fIfilename\fR
.IP
Use \fIfilename\fR instead of $HOME/.x11vncrc for rc file.
.PP
\fB-norc\fR
.IP
Do not process any .x11vncrc file for options.
.PP
2143 2144 2145 2146 2147 2148 2149 2150
\fB-env\fR \fIVAR=VALUE\fR
.IP
Set the environment variable 'VAR' to value 'VALUE'
at x11vnc startup.  This is a convenience utility to
avoid shell script wrappers, etc. to set the env. var.
You may specify as many of these as needed on the
command line.
.PP
2151 2152 2153 2154 2155
\fB-prog\fR \fI/path/to/x11vnc\fR
.IP
Set the full path to the x11vnc program for cases when
it cannot be determined from argv[0] (e.g. tcpd/inetd)
.PP
2156 2157 2158
\fB-h,\fR \fB-help\fR
.IP
Print this help text.
2159
-?, \fB-opts\fR              Only list the x11vnc options.
2160 2161 2162
.PP
\fB-V,\fR \fB-version\fR
.IP
2163
Print program version and last modification date.
2164
.PP
2165 2166 2167 2168 2169
\fB-license\fR
.IP
Print out license information.  Same as \fB-copying\fR and
\fB-warranty.\fR
.PP
2170 2171
\fB-dbg\fR
.IP
2172
Instead of exiting after cleaning up, run a simple
2173 2174
"debug crash shell" when fatal errors are trapped.
.PP
2175
\fB-q,\fR \fB-quiet\fR
2176 2177
.IP
Be quiet by printing less informational output to
2178 2179 2180 2181 2182
stderr.
.PP
\fB-v,\fR \fB-verbose\fR
.IP
Print out more information to stderr.
2183 2184 2185 2186 2187 2188 2189
.PP
\fB-bg\fR
.IP
Go into the background after screen setup.  Messages to
stderr are lost unless \fB-o\fR logfile is used.  Something
like this could be useful in a script:
.IP
2190
port=`ssh -t $host "x11vnc -display :0 -bg" | grep PORT`
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
.IP
port=`echo "$port" | sed -e 's/PORT=//'`
.IP
port=`expr $port - 5900`
.IP
vncviewer $host:$port
.PP
\fB-modtweak,\fR \fB-nomodtweak\fR
.IP
Option \fB-modtweak\fR automatically tries to adjust the AltGr
and Shift modifiers for differing language keyboards
between client and host.  Otherwise, only a single key
press/release of a Keycode is simulated (i.e. ignoring
the state of the modifiers: this usually works for
identical keyboards).  Also useful in resolving cases
where a Keysym is bound to multiple keys (e.g. "<" + ">"
and "," + "<" keys).  Default: \fB-modtweak\fR
2208 2209 2210 2211 2212 2213 2214 2215
.IP
On some HP-UX systems it is been noted that they have
an odd keymapping where a single keycode will have a
keysym, e.g. "#", up to three times.  You can check
via "xmodmap \fB-pk"\fR or the \fB-dk\fR option.  The failure
is when you try to type "#" it yields "3".  If you
see this problem try setting the environment variable
MODTWEAK_LOWEST=1 to see if it helps.
2216
.PP
2217
\fB-xkb,\fR \fB-noxkb\fR
2218
.IP
2219 2220 2221 2222
When in modtweak mode, use the XKEYBOARD extension (if
the X display supports it) to do the modifier tweaking.
This is powerful and should be tried if there are still
keymapping problems when using \fB-modtweak\fR by itself.
2223 2224 2225 2226
The default is to check whether some common keysyms,
e.g. !, @, [, are only accessible via \fB-xkb\fR mode and if
so then automatically enable the mode.  To disable this
automatic detection use \fB-noxkb.\fR
2227
.PP
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
\fB-capslock\fR
.IP
When in \fB-modtweak\fR (the default) or \fB-xkb\fR mode,
if a keysym in the range A-Z comes in check the X
server to see if the Caps_Lock is set.  If it is do
not artificially press Shift to generate the keysym.
This will enable the CapsLock key to behave correctly
in some circumstances: namely *both* the VNC viewer
machine and the x11vnc X server are in the CapsLock
on state.  If one side has CapsLock on and the other
off and the keyboard is not behaving as you think it
should you should correct the CapsLock states (hint:
pressing CapsLock inside and outside of the viewer can
help toggle them both to the correct state).  However,
for best results do not use this option, but rather
*only* enable CapsLock on the VNC viewer side (i.e. by
pressing CapsLock outside of the viewer window, also
\fB-skip_lockkeys\fR below).  Also try \fB-nomodtweak\fR for a
possible workaround.
.PP
\fB-skip_lockkeys\fR
.IP
Have x11vnc ignore all Caps_Lock, Shift_Lock, Num_Lock,
Scroll_Lock keysyms received from viewers.  The idea is
you press Caps_Lock on the VNC Viewer side but that does
not change the lock state in the x11vnc-side X server.
Nevertheless your capitalized letters come in over
the wire and are applied correctly to the x11vnc-side
X server.  Note this mode probably won't do what you
want in \fB-nomodtweak\fR mode.  Also, a kludge for KP_n
digits is always done it this mode: they are mapped to
regular digit keysyms.  See also \fB-capslock\fR above.
.PP
2261 2262
\fB-skip_keycodes\fR \fIstring\fR
.IP
2263 2264 2265 2266 2267 2268 2269
Ignore the comma separated list of decimal keycodes.
Perhaps these are keycodes not on your keyboard but
your X server thinks exist.  Currently only applies
to \fB-xkb\fR mode.  Use this option to help x11vnc in the
reverse problem it tries to solve: Keysym -> Keycode(s)
when ambiguities exist (more than one Keycode per
Keysym).  Run 'xmodmap \fB-pk'\fR to see your keymapping.
2270
Example: "\fB-skip_keycodes\fR \fI94,114\fR"
2271
.PP
2272 2273 2274 2275 2276 2277 2278 2279
\fB-sloppy_keys\fR
.IP
Experimental option that tries to correct some
"sloppy" key behavior.  E.g. if at the viewer you
press Shift+Key but then release the Shift before
Key that could give rise to extra unwanted characters
(usually only between keyboards of different languages).
Only use this option if you observe problems with
2280
some keystrokes.
2281
.PP
2282 2283 2284
\fB-skip_dups,\fR \fB-noskip_dups\fR
.IP
Some VNC viewers send impossible repeated key events,
2285 2286
e.g. key-down, key-down, key-up, key-up all for the same
key, or 20 downs in a row for the same modifier key!
2287
Setting \fB-skip_dups\fR means to skip these duplicates and
2288 2289 2290 2291 2292
just process the first event. Note: some VNC viewers
assume they can send down's without the corresponding
up's and so you should not set this option for
these viewers (symptom: some keys do not autorepeat)
Default: \fB-noskip_dups\fR
2293 2294
.PP
\fB-add_keysyms,\fR \fB-noadd_keysyms\fR
2295
.IP
2296 2297 2298 2299 2300
If a Keysym is received from a VNC viewer and that
Keysym does not exist in the X server, then add the
Keysym to the X server's keyboard mapping on an unused
key.  Added Keysyms will be removed periodically and
also when x11vnc exits.  Default: \fB-add_keysyms\fR
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
.PP
\fB-clear_mods\fR
.IP
At startup and exit clear the modifier keys by sending
KeyRelease for each one. The Lock modifiers are skipped.
Used to clear the state if the display was accidentally
left with any pressed down.
.PP
\fB-clear_keys\fR
.IP
As \fB-clear_mods,\fR except try to release any pressed key.
Note that this option and \fB-clear_mods\fR can interfere
with a person typing at the physical keyboard.
.PP
\fB-remap\fR \fIstring\fR
.IP
Read Keysym remappings from file named \fIstring\fR.
Format is one pair of Keysyms per line (can be name
or hex value) separated by a space.  If no file named
\fIstring\fR exists, it is instead interpreted as this
form: key1-key2,key3-key4,...  See <X11/keysymdef.h>
2322
header file for a list of Keysym names, or use 
2323
.IR xev (1).
2324 2325 2326
To map a key to a button click, use the fake Keysyms
"Button1", ..., etc. E.g: "\fB-remap\fR \fISuper_R-Button2\fR"
(useful for pasting on a laptop)
2327
.IP
2328 2329 2330
To disable a keysym (i.e. make it so it will not be
injected), remap it to "NoSymbol" or "None".
.IP
2331 2332 2333
Dead keys: "dead" (or silent, mute) keys are keys that
do not produce a character but must be followed by a 2nd
keystroke.  This is often used for accenting characters,
2334
e.g. to put "`" on top of "a" by pressing the dead
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
key and then "a".  Note that this interpretation
is not part of core X11, it is up to the toolkit or
application to decide how to react to the sequence.
The X11 names for these keysyms are "dead_grave",
"dead_acute", etc.  However some VNC viewers send the
keysyms "grave", "acute" instead thereby disabling
the accenting.  To work around this \fB-remap\fR can be used.
For example "\fB-remap\fR \fIgrave-dead_grave,acute-dead_acute\fR"
.IP
As a convenience, "\fB-remap\fR \fIDEAD\fR" applies these remaps:
.IP
      g     grave-dead_grave
      a     acute-dead_acute
      c     asciicircum-dead_circumflex
      t     asciitilde-dead_tilde
      m     macron-dead_macron
      b     breve-dead_breve
      D     abovedot-dead_abovedot
      d     diaeresis-dead_diaeresis
      o     degree-dead_abovering
      A     doubleacute-dead_doubleacute
      r     caron-dead_caron
      e     cedilla-dead_cedilla
.IP
.IP
If you just want a subset use the first letter
label, e.g. "\fB-remap\fR \fIDEAD=ga\fR" to get the first two.
Additional remaps may also be supplied via commas,
e.g.  "\fB-remap\fR \fIDEAD=ga,Super_R-Button2\fR".  Finally,
"DEAD=missing" means to apply all of the above as
long as the left hand member is not already in the
X11 keymap.
2367 2368 2369
.PP
\fB-norepeat,\fR \fB-repeat\fR
.IP
2370 2371 2372
Option \fB-norepeat\fR disables X server key auto repeat when
VNC clients are connected and VNC keyboard input is
not idle for more than 5 minutes.  This works around a
2373
repeating keystrokes bug (triggered by long processing
2374 2375 2376 2377
delays between key down and key up client events: either
from large screen changes or high latency).
Default: \fB-norepeat\fR
.IP
2378 2379
Note: your VNC viewer side will likely do autorepeating,
so this is no loss unless someone is simultaneously at
2380
the real X display.
2381 2382 2383
.IP
Use "\fB-norepeat\fR \fIN\fR" to set how many times norepeat will
be reset if something else (e.g. X session manager)
2384
undoes it.  The default is 2.  Use a negative value
2385
for unlimited resets.
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400
.PP
\fB-nofb\fR
.IP
Ignore video framebuffer: only process keyboard and
pointer.  Intended for use with Win2VNC and x2vnc
dual-monitor setups.
.PP
\fB-nobell\fR
.IP
Do not watch for XBell events. (no beeps will be heard)
Note: XBell monitoring requires the XKEYBOARD extension.
.PP
\fB-nosel\fR
.IP
Do not manage exchange of X selection/cutbuffer between
2401
VNC viewers and the X server at all.
2402 2403 2404 2405 2406 2407 2408
.PP
\fB-noprimary\fR
.IP
Do not poll the PRIMARY selection for changes to send
back to clients.  (PRIMARY is still set on received
changes, however).
.PP
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
\fB-nosetprimary\fR
.IP
Do not set the PRIMARY selection for changes received
from VNC clients.
.PP
\fB-noclipboard\fR
.IP
Do not poll the CLIPBOARD selection for changes to send
back to clients.  (CLIPBOARD is still set on received
changes, however).
.PP
\fB-nosetclipboard\fR
.IP
Do not set the CLIPBOARD selection for changes
received from VNC clients.
.PP
2425 2426 2427 2428 2429 2430 2431 2432 2433
\fB-seldir\fR \fIstring\fR
.IP
If direction string is "send", only send the selection
to viewers, and if it is "recv" only receive it from
viewers.  To work around apps setting the selection
too frequently and messing up the other end.  You can
actually supply a comma separated list of directions,
including "debug" to turn on debugging output.
.PP
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
\fB-cursor\fR \fI[mode],\fR \fB-nocursor\fR
.IP
Sets how the pointer cursor shape (little icon at the
mouse pointer) should be handled.  The "mode" string
is optional and is described below.  The default
is to show some sort of cursor shape(s).  How this
is done depends on the VNC viewer and the X server.
Use \fB-nocursor\fR to disable cursor shapes completely.
.IP
Some VNC viewers support the TightVNC CursorPosUpdates
and CursorShapeUpdates extensions (cuts down on
network traffic by not having to send the cursor image
every time the pointer is moved), in which case these
extensions are used (see \fB-nocursorshape\fR and \fB-nocursorpos\fR
2448 2449 2450 2451 2452 2453
below to disable).  For other viewers the cursor shape
is written directly to the framebuffer every time the
pointer is moved or changed and gets sent along with
the other framebuffer updates.  In this case, there
will be some lag between the vnc viewer pointer and
the remote cursor position.
2454 2455
.IP
If the X display supports retrieving the cursor shape
2456 2457 2458
information from the X server, then the default is
to use that mode.  On Solaris this can be done with
the SUN_OVL extension using \fB-overlay\fR (see also the
2459
\fB-overlay_nocursor\fR option).  A similar overlay scheme
2460 2461 2462 2463 2464 2465 2466
is used on IRIX.  Xorg (e.g. Linux) and recent Solaris
Xsun servers support the XFIXES extension to retrieve
the exact cursor shape from the X server.  If XFIXES
is present it is preferred over Overlay and is used by
default (see \fB-noxfixes\fR below).  This can be disabled
with \fB-nocursor,\fR and also some values of the "mode"
option below.
2467
.IP
2468
Note that under XFIXES cursors with transparency (alpha
2469 2470 2471 2472
channel) will usually not be exactly represented and one
may find Overlay preferable.  See also the \fB-alphacut\fR
and \fB-alphafrac\fR options below as fudge factors to try
to improve the situation for cursors with transparency
2473 2474
for a given theme.
.IP
2475 2476 2477 2478
The "mode" string can be used to fine-tune the
displaying of cursor shapes.  It can be used the
following ways:
.IP
2479 2480 2481 2482 2483 2484
"\fB-cursor\fR \fIarrow\fR" - just show the standard arrow
nothing more or nothing less.
.IP
"\fB-cursor\fR \fInone\fR" - same as "\fB-nocursor\fR"
.IP
"\fB-cursor\fR \fIX\fR" - when the cursor appears to be on the
2485 2486 2487 2488 2489 2490 2491
root window, draw the familiar X shape.  Some desktops
such as GNOME cover up the root window completely,
and so this will not work, try "X1", etc, to try to
shift the tree depth.  On high latency links or slow
machines there will be a time lag between expected and
the actual cursor shape.
.IP
2492
"\fB-cursor\fR \fIsome\fR" - like "X" but use additional
2493 2494 2495 2496 2497 2498
heuristics to try to guess if the window should have
a windowmanager-like resizer cursor or a text input
I-beam cursor.  This is a complete hack, but may be
useful in some situations because it provides a little
more feedback about the cursor shape.
.IP
2499 2500 2501 2502 2503 2504
"\fB-cursor\fR \fImost\fR" - try to show as many cursors as
possible.  Often this will only be the same as "some"
unless the display has overlay visuals or XFIXES
extensions available.  On Solaris and IRIX if XFIXES
is not available, \fB-overlay\fR mode will be attempted.
.PP
2505 2506 2507 2508 2509 2510
\fB-cursor_drag\fR
.IP
Show cursor shape changes even when the mouse is being
dragged with a mouse button down.  This is useful if you
want to be able to see Drag-and-Drop cursor icons, etc.
.PP
2511 2512 2513 2514
\fB-arrow\fR \fIn\fR
.IP
Choose an alternate "arrow" cursor from a set of
some common ones.  n can be 1 to 6.  Default is: 1
2515
Ignored when in XFIXES cursor-grabbing mode.
2516
.PP
2517 2518 2519 2520
\fB-noxfixes\fR
.IP
Do not use the XFIXES extension to draw the exact cursor
shape even if it is available.
2521
.PP
2522 2523 2524
\fB-alphacut\fR \fIn\fR
.IP
When using the XFIXES extension for the cursor shape,
2525 2526 2527 2528 2529 2530 2531
cursors with transparency will not usually be displayed
exactly (but opaque ones will).  This option sets n as
a cutoff for cursors that have transparency ("alpha
channel" with values ranging from 0 to 255) Any cursor
pixel with alpha value less than n becomes completely
transparent.  Otherwise the pixel is completely opaque.
Default 240
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549
.PP
\fB-alphafrac\fR \fIfraction\fR
.IP
With the threshold in \fB-alphacut\fR some cursors will become
almost completely transparent because their alpha values
are not high enough.  For those cursors adjust the
alpha threshold until fraction of the non-zero alpha
channel pixels become opaque.  Default 0.33
.PP
\fB-alpharemove\fR
.IP
By default, XFIXES cursors pixels with transparency have
the alpha factor multiplied into the RGB color values
(i.e. that corresponding to blending the cursor with a
black background).  Specify this option to remove the
alpha factor. (useful for light colored semi-transparent
cursors).
.PP
2550
\fB-noalphablend\fR
2551
.IP
2552 2553 2554 2555 2556 2557 2558 2559
In XFIXES mode do not send cursor alpha channel data
to libvncserver.  The default is to send it.  The
alphablend effect will only be visible in \fB-nocursorshape\fR
mode or for clients with cursorshapeupdates turned
off. (However there is a hack for 32bpp with depth 24,
it uses the extra 8 bits to store cursor transparency
for use with a hacked vncviewer that applies the
transparency locally.  See the FAQ for more info).
2560
.PP
2561 2562 2563 2564
\fB-nocursorshape\fR
.IP
Do not use the TightVNC CursorShapeUpdates extension
even if clients support it.  See \fB-cursor\fR above.
2565 2566 2567 2568 2569
.PP
\fB-cursorpos,\fR \fB-nocursorpos\fR
.IP
Option \fB-cursorpos\fR enables sending the X cursor position
back to all vnc clients that support the TightVNC
2570 2571 2572
CursorPosUpdates extension.  Other clients will be able
to see the pointer motions. Default: \fB-cursorpos\fR
.PP
2573
\fB-xwarppointer,\fR \fB-noxwarppointer\fR
2574
.IP
2575 2576 2577 2578 2579 2580
Move the pointer with 
.IR XWarpPointer (3X)
instead of
the XTEST extension.  Use this as a workaround
if the pointer motion behaves incorrectly, e.g.
on touchscreens or other non-standard setups.
2581 2582 2583 2584
.IP
It is also sometimes needed on XINERAMA displays and is
enabled by default if XINERAMA is found to be active.
To prevent this, use \fB-noxwarppointer.\fR
2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616
.PP
\fB-buttonmap\fR \fIstring\fR
.IP
String to remap mouse buttons.  Format: IJK-LMN, this
maps buttons I -> L, etc., e.g.  \fB-buttonmap\fR 13-31
.IP
Button presses can also be mapped to keystrokes: replace
a button digit on the right of the dash with :<sym>:
or :<sym1>+<sym2>: etc. for multiple keys. For example,
if the viewing machine has a mouse-wheel (buttons 4 5)
but the x11vnc side does not, these will do scrolls:
.IP
\fB-buttonmap\fR 12345-123:Prior::Next:
.IP
\fB-buttonmap\fR 12345-123:Up+Up+Up::Down+Down+Down:
.IP
See <X11/keysymdef.h> header file for a list of Keysyms,
or use the 
.IR xev (1)
program.  Note: mapping of button
clicks to Keysyms may not work if \fB-modtweak\fR or \fB-xkb\fR is
needed for the Keysym.
.IP
If you include a modifier like "Shift_L" the
modifier's up/down state is toggled, e.g. to send
"The" use :Shift_L+t+Shift_L+h+e: (the 1st one is
shift down and the 2nd one is shift up). (note: the
initial state of the modifier is ignored and not reset)
To include button events use "Button1", ... etc.
.PP
\fB-nodragging\fR
.IP
2617 2618 2619 2620
Do not update the display during mouse dragging events
(mouse button held down).  Greatly improves response on
slow setups, but you lose all visual feedback for drags,
text selection, and some menu traversals.  It overrides
2621
any \fB-pointer_mode\fR setting.
2622
.PP
2623 2624 2625 2626 2627 2628 2629 2630
\fB-ncache\fR \fIn\fR
.IP
Client-side caching scheme.  Framebuffer memory \fIn\fR
(an integer) times that of the full display is allocated
below the actual framebuffer to cache screen contents
for rapid retrieval.  So a W x H frambuffer is expanded
to a W x (n+1)*H one.  Use 0 to disable.  Default: XXX.
.IP
2631 2632
The \fIn\fR is actually optional, the default is 10.
.IP
2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
For this and the other \fB-ncache*\fR options below you can
abbreviate "\fB-ncache\fR" with "\fB-nc\fR".  Also, "\fB-nonc\fR"
is the same as "\fB-ncache\fR \fI0\fR"
.IP
This is an experimental option, currently implemented
in an awkward way in that in the VNC Viewer you can
see the cache contents if you scroll down, etc.  So you
will have to set things up so you can't see that region.
If this method is successful, the changes required for
clients to do this less awkwardly will be investigated.
.IP
Note that this mode consumes a huge amount of memory,
both on the x11vnc server side and on the VNC Viewer
side.  If n=2 then the amount of RAM used is roughly
tripled for both x11vnc and the VNC Viewer.  As a rule
of thumb, note that 1280x1024 at depth 24 is about 5MB
of pixel data.
.IP
For reasonable response when cycling through 4 to 6
large (e.g. web browser) windows a value n of 6 to 12
is recommended. (that's right: ~10X more memory...)
.IP
Because of the way window backingstore and saveunders
are implemented, n must be even.  It will be incremented
by 1 if it is not.
.IP
This mode also works for native MacOS X, but may not
be as effective as the X version.  This is due to a
number of things, one is the drop-shadow compositing
that leaves extra areas that need to be repaired (see
\fB-ncache_pad).\fR  Another is the window iconification
animations need to be avoided (see \fB-macicontime).\fR
It appears the that the 'Scale' animation mode gives
better results than the 'Genie' one.  Also, window event
detection not as accurate as the X version.
.PP
\fB-ncache_cr\fR
.IP
In \fB-ncache\fR mode, try to do copyrect opaque window
moves/drags instead of wireframes (this can induce
painting errors).  The wireframe will still be used when
moving a window whose save-unders has not yet been set
or has been invalidated.
.IP
Some VNC Viewers provide better response than others
with this option.  On Unix, realvnc viewer gives
smoother drags than tightvnc viewer.  Response may also
be choppy if the server side machine is too slow.
.IP
Sometimes on very slow modem connections, this actually
gives an improvement because no pixel data at all
(not even the box animation) is sent during the drag.
.PP
\fB-ncache_no_moveraise\fR
.IP
In \fB-ncache\fR mode, do not assume that moving a window
will cause the window manager to raise it to the top
of the stack.  The default is to assume it does, and
so at the beginning of any wireframe, etc, window moves
the window will be pushed to top in the VNC viewer.
.PP
\fB-ncache_no_dtchange\fR
.IP
In \fB-ncache\fR mode, do not try to guess when the desktop
(viewport) changes to another one (i.e. another
workarea).  The default is to try to guess and when
detected try to make the transistion more smoothly.
.PP
\fB-ncache_no_rootpixmap\fR
.IP
In \fB-ncache\fR mode, do not try to snapshot the desktop
background to use in guessing or reconstructing window
save-unders.
.PP
\fB-ncache_keep_anims\fR
.IP
In \fB-ncache\fR mode, do not try to disable window
manager animations and other effects (that usually
degrade ncache performance or cause painting errors).
The default is to try to disable them on KDE (but not
GNOME) when VNC clients are connected.
.IP
For other window managers or desktops that provide
animations, effects, compositing, translucency,
etc. that interfere with the \fB-ncache\fR method you will
have to disable them manually.
.PP
\fB-ncache_old_wm\fR
.IP
In \fB-ncache\fR mode, enable some heuristics for old style
window managers such as fvwm and twm.
.PP
\fB-ncache_pad\fR \fIn\fR
.IP
In \fB-ncache\fR mode, pad each window with n pixels for the
caching rectangles.  This can be used to try to improve
the situation with dropshadows or other compositing
(e.g. MacOS X window manager), although it could make
things worse.  The default is 0 on Unix and 24 on
MacOS X.
.PP
2734 2735 2736 2737
\fB-debug_ncache\fR
.IP
Turn on debugging and profiling output under \fB-ncache.\fR
.PP
2738 2739 2740 2741 2742 2743 2744 2745
\fB-wireframe\fR \fI[str],\fR \fB-nowireframe\fR
.IP
Try to detect window moves or resizes when a mouse
button is held down and show a wireframe instead of
the full opaque window.  This is based completely on
heuristics and may not always work: it depends on your
window manager and even how you move things around.
See \fB-pointer_mode\fR below for discussion of the "bogging
2746 2747 2748 2749
down" problem this tries to avoid.
Default: \fB-wireframe\fR
.IP
Shorter aliases:  \fB-wf\fR [str]  and \fB-nowf\fR
2750 2751 2752 2753
.IP
The value "str" is optional and, of course, is
packed with many tunable parameters for this scheme:
.IP
2754
Format: shade,linewidth,percent,T+B+L+R,mod,t1+t2+t3+t4
2755
Default: 0xff,2,0,32+8+8+8,all,0.15+0.30+5.0+0.125
2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
.IP
If you leave nothing between commas: ",," the default
value is used.  If you don't specify enough commas,
the trailing parameters are set to their defaults.
.IP
"shade" indicate the "color" for the wireframe,
usually a greyscale: 0-255, however for 16 and 32bpp you
can specify an rgb.txt X color (e.g. "dodgerblue") or
a value > 255 is treated as RGB (e.g. red is 0xff0000).
"linewidth" sets the width of the wireframe in pixels.
"percent" indicates to not apply the wireframe scheme
to windows with area less than this percent of the
full screen.
.IP
"T+B+L+R" indicates four integers for how close in
pixels the pointer has to be from the Top, Bottom, Left,
or Right edges of the window to consider wireframing.
This is a speedup to quickly exclude a window from being
wireframed: set them all to zero to not try the speedup
(scrolling and selecting text will likely be slower).
.IP
2777 2778 2779 2780 2781 2782 2783 2784
"mod" specifies if a button down event in the
interior of the window with a modifier key (Alt, Shift,
etc.) down should indicate a wireframe opportunity.
It can be "0" or "none" to skip it, "1" or "all"
to apply it to any modifier, or "Shift", "Alt",
"Control", "Meta", "Super", or "Hyper" to only
apply for that type of modifier key.
.IP
2785 2786 2787 2788 2789 2790
"t1+t2+t3+t4" specify four floating point times in
seconds: t1 is how long to wait for the pointer to move,
t2 is how long to wait for the window to start moving
or being resized (for some window managers this can be
rather long), t3 is how long to keep a wireframe moving
before repainting the window. t4 is the minimum time
2791 2792 2793
between sending wireframe "animations".  If a slow
link is detected, these values may be automatically
changed to something better for a slow link.
2794
.PP
2795 2796 2797 2798 2799 2800 2801 2802
\fB-nowireframelocal\fR
.IP
By default, mouse motion and button presses of a
user sitting at the LOCAL display are monitored for
wireframing opportunities (so that the changes will be
sent efficiently to the VNC clients).  Use this option
to disable this behavior.
.PP
2803 2804 2805
\fB-wirecopyrect\fR \fImode,\fR \fB-nowirecopyrect\fR
.IP
Since the \fB-wireframe\fR mechanism evidently tracks moving
2806 2807 2808 2809 2810 2811 2812 2813
windows accurately, a speedup can be obtained by
telling the VNC viewers to locally copy the translated
window region.  This is the VNC CopyRect encoding:
the framebuffer update doesn't need to send the actual
new image data.
.IP
Shorter aliases:  \fB-wcr\fR [mode]  and \fB-nowcr\fR
.IP
2814 2815 2816 2817 2818
"mode" can be "never" (same as \fB-nowirecopyrect)\fR
to never try the copyrect, "top" means only do it if
the window was not covered by any other windows, and
"always" means to translate the orginally unobscured
region (this may look odd as the remaining pieces come
2819 2820
in, but helps on a slow link).  Default: "always"
.IP
2821 2822 2823 2824 2825
Note: there can be painting errors or slow response
when using \fB-scale\fR so you may want to disable CopyRect
in this case "\fB-wirecopyrect\fR \fInever\fR" on the command
line or by remote-control.  Or you can also use the
"\fB-scale\fR \fIxxx:nocr\fR" scale option.
2826
.PP
2827 2828 2829 2830 2831 2832
\fB-debug_wireframe\fR
.IP
Turn on debugging info printout for the wireframe
heuristics.  "\fB-dwf\fR" is an alias.  Specify multiple
times for more output.
.PP
2833 2834 2835 2836 2837 2838 2839 2840 2841 2842
\fB-scrollcopyrect\fR \fImode,\fR \fB-noscrollcopyrect\fR
.IP
Like \fB-wirecopyrect,\fR but use heuristics to try to guess
if a window has scrolled its contents (either vertically
or horizontally).  This requires the RECORD X extension
to "snoop" on X applications (currently for certain
XCopyArea and XConfigureWindow X protocol requests).
Examples: Hitting <Return> in a terminal window when the
cursor was at the bottom, the text scrolls up one line.
Hitting <Down> arrow in a web browser window, the web
2843 2844
page scrolls up a small amount.  Or scrolling with a
scrollbar or mouse wheel.
2845 2846 2847 2848 2849 2850 2851
.IP
Shorter aliases:  \fB-scr\fR [mode]  and \fB-noscr\fR
.IP
This scheme will not always detect scrolls, but when
it does there is a nice speedup from using the VNC
CopyRect encoding (see \fB-wirecopyrect).\fR  The speedup
is both in reduced network traffic and reduced X
2852 2853 2854 2855 2856 2857 2858
framebuffer polling/copying.  On the other hand, it may
induce undesired transients (e.g. a terminal cursor
being scrolled up when it should not be) or other
painting errors (window tearing, bunching-up, etc).
These are automatically repaired in a short period
of time.  If this is unacceptable disable the feature
with \fB-noscrollcopyrect.\fR
2859
.IP
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
Screen clearing kludges:  for testing at least, there
are some "magic key sequences" (must be done in less
than 1 second) to aid repairing painting errors that
may be seen when using this mode:
.IP
3 Alt_L's   in a row: resend whole screen,
4 Alt_L's   in a row: reread and resend whole screen,
3 Super_L's in a row: mark whole screen for polling,
4 Super_L's in a row: reset RECORD context,
5 Super_L's in a row: try to push a black screen
.IP
2871 2872 2873 2874 2875 2876 2877
note: Alt_L is the Left "Alt" key (a single key)
Super_L is the Left "Super" key (Windows flag).
Both of these are modifier keys, and so should not
generate characters when pressed by themselves.  Also,
your VNC viewer may have its own refresh hot-key
or button.
.IP
2878 2879 2880 2881 2882 2883
"mode" can be "never" (same as \fB-noscrollcopyrect)\fR
to never try the copyrect, "keys" means to try it
in response to keystrokes only, "mouse" means to
try it in response to mouse events only, "always"
means to do both. Default: "always"
.IP
2884 2885 2886 2887 2888
Note: there can be painting errors or slow response
when using \fB-scale\fR so you may want to disable CopyRect
in this case "\fB-scrollcopyrect\fR \fInever\fR" on the command
line or by remote-control.  Or you can also use the
"\fB-scale\fR \fIxxx:nocr\fR" scale option.
2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899
.PP
\fB-scr_area\fR \fIn\fR
.IP
Set the minimum area in pixels for a rectangle
to be considered for the \fB-scrollcopyrect\fR detection
scheme.  This is to avoid wasting the effort on small
rectangles that would be quickly updated the normal way.
E.g. suppose an app updated the position of its skinny
scrollbar first and then shifted the large panel
it controlled.  We want to be sure to skip the small
scrollbar and get the large panel. Default: 60000
2900
.PP
2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922
\fB-scr_skip\fR \fIlist\fR
.IP
Skip scroll detection for applications matching
the comma separated list of strings in \fIlist\fR.
Some applications implement their scrolling in
strange ways where the XCopyArea, etc, also applies
to invisible portions of the window: if we CopyRect
those areas it looks awful during the scroll and
there may be painting errors left after the scroll.
Soffice.bin is the worst known offender.
.IP
Use "##" to denote the start of the application class
(e.g. "##XTerm") and "++" to denote the start
of the application instance name (e.g. "++xterm").
The string your list is matched against is of the form
"^^WM_NAME##Class++Instance<same-for-any-subwindows>"
The "xlsclients \fB-la"\fR command will provide this info.
.IP
If a pattern is prefixed with "KEY:" it only applies
to Keystroke generated scrolls (e.g. Up arrow).  If it
is prefixed with "MOUSE:" it only applies to Mouse
induced scrolls (e.g. dragging on a scrollbar).
2923
Default: ##Soffice.bin,##StarOffice
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
.PP
\fB-scr_inc\fR \fIlist\fR
.IP
Opposite of \fB-scr_skip:\fR this list is consulted first
and if there is a match the window will be monitored
via RECORD for scrolls irrespective of \fB-scr_skip.\fR
Use \fB-scr_skip\fR '*' to skip anything that does not match
your \fB-scr_inc.\fR  Use \fB-scr_inc\fR '*' to include everything.
.PP
\fB-scr_keys\fR \fIlist\fR
.IP
For keystroke scroll detection, only apply the RECORD
heuristics to the comma separated list of keysyms in
\fIlist\fR.  You may find the RECORD overhead for every
one of your keystrokes disrupts typing too much, but you
don't want to turn it off completely with "\fB-scr\fR \fImouse\fR"
and \fB-scr_parms\fR does not work or is too confusing.
.IP
The listed keysyms can be numeric or the keysym
names in the <X11/keysymdef.h> header file or from the
.IR xev (1)
program.  Example: "\fB-scr_keys\fR \fIUp,Down,Return\fR".
One probably wants to have application specific lists
(e.g. for terminals, etc) but that is too icky to think
about for now...
.IP
If \fIlist\fR begins with the "-" character the list
is taken as an exclude list: all keysyms except those
list will be considered.  The special string "builtin"
expands to an internal list of keysyms that are likely
to cause scrolls.  BTW, by default modifier keys,
Shift_L, Control_R, etc, are skipped since they almost
never induce scrolling by themselves.
.PP
2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
\fB-scr_term\fR \fIlist\fR
.IP
Yet another cosmetic kludge.  Apply shell/terminal
heuristics to applications matching comma separated
list (same as for \fB-scr_skip/-scr_inc).\fR  For example an
annoying transient under scroll detection is if you
hit Enter in a terminal shell with full text window,
the solid text cursor block will be scrolled up.
So for a short time there are two (or more) block
cursors on the screen.  There are similar scenarios,
(e.g. an output line is duplicated).
.IP
These transients are induced by the approximation of
scroll detection (e.g. it detects the scroll, but not
the fact that the block cursor was cleared just before
the scroll).  In nearly all cases these transient errors
are repaired when the true X framebuffer is consulted
by the normal polling.  But they are distracting, so
what this option provides is extra "padding" near the
bottom of the terminal window: a few extra lines near
the bottom will not be scrolled, but rather updated
from the actual X framebuffer.  This usually reduces
the annoying artifacts.  Use "none" to disable.
Default: "term"
.PP
2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997
\fB-scr_keyrepeat\fR \fIlo-hi\fR
.IP
If a key is held down (or otherwise repeats rapidly) and
this induces a rapid sequence of scrolls (e.g. holding
down an Arrow key) the "scrollcopyrect" detection
and overhead may not be able to keep up.  A time per
single scroll estimate is performed and if that estimate
predicts a sustainable scrollrate of keys per second
between "lo" and "hi" then repeated keys will be
DISCARDED to maintain the scrollrate. For example your
key autorepeat may be 25 keys/sec, but for a large
window or slow link only 8 scrolls per second can be
sustained, then roughly 2 out of every 3 repeated keys
will be discarded during this period. Default: "4-20"
.PP
2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
\fB-scr_parms\fR \fIstring\fR
.IP
Set various parameters for the scrollcopyrect mode.
The format is similar to that for \fB-wireframe\fR and packed
with lots of parameters:
.IP
Format: T+B+L+R,t1+t2+t3,s1+s2+s3+s4+s5
Default: 0+64+32+32,0.02+0.10+0.9,0.03+0.06+0.5+0.1+5.0
.IP
If you leave nothing between commas: ",," the default
value is used.  If you don't specify enough commas,
the trailing parameters are set to their defaults.
.IP
"T+B+L+R" indicates four integers for how close in
pixels the pointer has to be from the Top, Bottom, Left,
or Right edges of the window to consider scrollcopyrect.
If \fB-wireframe\fR overlaps it takes precedence.  This is a
speedup to quickly exclude a window from being watched
for scrollcopyrect: set them all to zero to not try
the speedup (things like selecting text will likely
be slower).
.IP
"t1+t2+t3" specify three floating point times in
seconds that apply to scrollcopyrect detection with
*Keystroke* input: t1 is how long to wait after a key
is pressed for the first scroll, t2 is how long to keep
looking after a Keystroke scroll for more scrolls.
t3 is how frequently to try to update surrounding
scrollbars outside of the scrolling area (0.0 to
disable)
.IP
"s1+s2+s3+s4+s5" specify five floating point times
in seconds that apply to scrollcopyrect detection with
*Mouse* input: s1 is how long to wait after a mouse
button is pressed for the first scroll, s2 is how long
to keep waiting for additional scrolls after the first
Mouse scroll was detected.  s3 is how frequently to
try to update surrounding scrollbars outside of the
scrolling area (0.0 to disable).  s4 is how long to
buffer pointer motion (to try to get fewer, bigger
mouse scrolls). s5 is the maximum time to spend just
updating the scroll window without updating the rest
of the screen.
.PP
3042 3043 3044 3045 3046 3047 3048 3049 3050
\fB-fixscreen\fR \fIstring\fR
.IP
Periodically "repair" the screen based on settings
in \fIstring\fR.  Hopefully you won't need this option,
it is intended for cases when the \fB-scrollcopyrect\fR or
\fB-wirecopyrect\fR features leave too many painting errors,
but it can be used for any scenario.  This option
periodically performs costly operations and so
interactive response may be reduced when it is on.
3051 3052 3053
You can use 3 Alt_L's (the Left "Alt" key) taps in
a row (as described under \fB-scrollcopyrect)\fR instead to
manually request a screen repaint when it is needed.
3054 3055
.IP
\fIstring\fR is a comma separated list of one or more of
3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069
the following: "V=t", "C=t", "X=t", and "8=t".
In these "t" stands for a time in seconds (it is
a floating point even though one should usually use
values > 2 to avoid wasting resources).  V sets how
frequently the entire screen should be sent to viewers
(it is like the 3 Alt_L's).  C sets how long to wait
after a CopyRect to repaint the full screen.  X sets
how frequently to reread the full X11 framebuffer from
the X server and push it out to connected viewers.
Use of X should be rare, please report a bug if you
find you need it. 8= applies only for \fB-8to24\fR mode: it
sets how often the non-default visual regions of the
screen (e.g. 8bpp windows) are refreshed.  Examples:
\fB-fixscreen\fR V=10 \fB-fixscreen\fR C=10
3070
.PP
3071 3072 3073 3074 3075 3076
\fB-debug_scroll\fR
.IP
Turn on debugging info printout for the scroll
heuristics.  "\fB-ds\fR" is an alias.  Specify it multiple
times for more output.
.PP
3077 3078 3079 3080 3081 3082
\fB-noxrecord\fR
.IP
Disable any use of the RECORD extension.  This is
currently used by the \fB-scrollcopyrect\fR scheme and to
monitor X server grabs.
.PP
3083 3084 3085 3086
\fB-grab_buster,\fR \fB-nograb_buster\fR
.IP
Some of the use of the RECORD extension can leave a
tiny window for XGrabServer deadlock.  This is only if
3087 3088 3089 3090 3091 3092 3093 3094
the whole-server grabbing application expects mouse or
keyboard input before releasing the grab.  It is usually
a window manager that does this.  x11vnc takes care to
avoid the the problem, but if caught x11vnc will freeze.
Without \fB-grab_buster,\fR the only solution is to go the
physical display and give it some input to satisfy the
grabbing app.  Or manually kill and restart the window
manager if that is feasible.  With \fB-grab_buster,\fR x11vnc
3095
will fork a helper thread and if x11vnc appears to be
3096 3097 3098 3099
stuck in a grab after a period of time (20-30 sec) then
it will inject some user input: button clicks, Escape,
mouse motion, etc to try to break the grab.  If you
experience a lot of grab deadlock, please report a bug.
3100
.PP
3101 3102 3103 3104 3105
\fB-debug_grabs\fR
.IP
Turn on debugging info printout with respect to
XGrabServer() deadlock for \fB-scrollcopyrect__mode_.\fR
.PP
3106 3107 3108 3109 3110
\fB-debug_sel\fR
.IP
Turn on debugging info printout with respect to
PRIMARY, CLIPBOARD, and CUTBUFFER0 selections.
.PP
3111 3112
\fB-pointer_mode\fR \fIn\fR
.IP
3113 3114
Various pointer motion update schemes. "\fB-pm\fR" is
an alias.  The problem is pointer motion can cause
3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128
rapid changes on the screen: consider the rapid
changes when you drag a large window around opaquely.
Neither x11vnc's screen polling and vnc compression
routines nor the bandwidth to the vncviewers can keep
up these rapid screen changes: everything will bog down
when dragging or scrolling.  So a scheme has to be used
to "eat" much of that pointer input before re-polling
the screen and sending out framebuffer updates. The
mode number \fIn\fR can be 0 to 4 and selects one of
the schemes desribed below.
.IP
Note that the \fB-wireframe\fR and \fB-scrollcopyrect__mode_s\fR
complement \fB-pointer_mode\fR by detecting (and improving)
certain periods of "rapid screen change".
3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140
.IP
n=0: does the same as \fB-nodragging.\fR (all screen polling
is suspended if a mouse button is pressed.)
.IP
n=1: was the original scheme used to about Jan 2004:
it basically just skips \fB-input_skip\fR keyboard or pointer
events before repolling the screen.
.IP
n=2 is an improved scheme: by watching the current rate
of input events it tries to detect if it should try to
"eat" additional pointer events before continuing.
.IP
3141
n=3 is basically a dynamic \fB-nodragging\fR mode: it detects
3142 3143 3144
when the mouse motion has paused and then refreshes
the display.
.IP
3145
n=4 attempts to measures network rates and latency,
3146 3147 3148 3149 3150
the video card read rate, and how many tiles have been
changed on the screen.  From this, it aggressively tries
to push screen "frames" when it decides it has enough
resources to do so.  NOT FINISHED.
.IP
3151 3152
The default n is 2. Note that modes 2, 3, 4 will skip
\fB-input_skip\fR keyboard events (but it will not count
3153 3154 3155 3156
pointer events).  Also note that these modes are not
available in \fB-threads\fR mode which has its own pointer
event handling mechanism.
.IP
3157 3158 3159 3160 3161
To try out the different pointer modes to see which
one gives the best response for your usage, it is
convenient to use the remote control function, for
example "x11vnc \fB-R\fR pm:4" or the tcl/tk gui (Tuning ->
pointer_mode -> n).
3162
.PP
3163 3164
\fB-input_skip\fR \fIn\fR
.IP
3165
For the pointer handling when non-threaded: try to
3166 3167
read n user input events before scanning display. n < 0
means to act as though there is always user input.
3168
Default: 10
3169
.PP
3170 3171 3172 3173 3174
\fB-allinput\fR
.IP
Have x11vnc read and process all available client input
before proceeding.
.PP
3175 3176 3177 3178
\fB-speeds\fR \fIrd,bw,lat\fR
.IP
x11vnc tries to estimate some speed parameters that
are used to optimize scheduling (e.g. \fB-pointer_mode\fR
3179 3180 3181 3182 3183 3184 3185 3186
4, \fB-wireframe,\fR \fB-scrollcopyrect)\fR and other things.
Use the \fB-speeds\fR option to set these manually.
The triple \fIrd,bw,lat\fR corresponds to video h/w
read rate in MB/sec, network bandwidth to clients in
KB/sec, and network latency to clients in milliseconds,
respectively.  If a value is left blank, e.g. "-speeds
,100,15", then the internal scheme is used to estimate
the empty value(s).
3187 3188 3189
.IP
Typical PC video cards have read rates of 5-10 MB/sec.
If the framebuffer is in main memory instead of video
3190 3191 3192 3193 3194 3195
h/w (e.g. SunRay, shadowfb, dummy driver, Xvfb), the
read rate may be much faster.  "x11perf \fB-getimage500"\fR
can be used to get a lower bound (remember to factor
in the bytes per pixel).  It is up to you to estimate
the network bandwith and latency to clients.  For the
latency the 
3196 3197 3198 3199 3200 3201 3202
.IR ping (1)
command can be used.
.IP
For convenience there are some aliases provided,
e.g. "\fB-speeds\fR \fImodem\fR".  The aliases are: "modem" for
6,4,200; "dsl" for 6,100,50; and "lan" for 6,5000,1
.PP
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213
\fB-wmdt\fR \fIstring\fR
.IP
For some features, e.g. \fB-wireframe\fR and \fB-scrollcopyrect,\fR
x11vnc has to work around issues for certain window
managers or desktops (currently kde and xfce).
By default it tries to guess which one, but it can
guess incorrectly.  Use this option to indicate which
wm/dt.  \fIstring\fR can be "gnome", "kde", "cde",
"xfce", or "root" (classic X wm).  Anything else
is interpreted as "root".
.PP
3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227
\fB-debug_pointer\fR
.IP
Print debugging output for every pointer event.
.PP
\fB-debug_keyboard\fR
.IP
Print debugging output for every keyboard event.
.PP
Same as \fB-dp\fR and \fB-dk,\fR respectively.  Use multiple
times for more output.
.PP
\fB-defer\fR \fItime\fR
.IP
Time in ms to wait for updates before sending to client
3228
(deferUpdateTime)  Default: 20
3229 3230 3231 3232
.PP
\fB-wait\fR \fItime\fR
.IP
Time in ms to pause between screen polls.  Used to cut
3233
down on load.  Default: 20
3234
.PP
3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
\fB-wait_ui\fR \fIfactor\fR
.IP
Factor by which to cut the \fB-wait\fR time if there
has been recent user input (pointer or keyboard).
Improves response, but increases the load whenever you
are moving the mouse or typing.  Default: 2.00
.PP
\fB-nowait_bog\fR
.IP
Do not detect if the screen polling is "bogging down"
and sleep more.  Some activities with no user input can
slow things down a lot: consider a large terminal window
with a long build running in it continously streaming
text output.  By default x11vnc will try to detect this
(3 screen polls in a row each longer than 0.25 sec with
no user input), and sleep up to 1.5 secs to let things
3251
"catch up".  Use this option to disable that detection.
3252
.PP
3253 3254 3255 3256 3257 3258 3259
\fB-slow_fb\fR \fItime\fR
.IP
Floating point time in seconds delay all screen polling.
For special purpose usage where a low frame rate is
acceptable and desirable, but you want the user input
processed at the normal rate so you cannot use \fB-wait.\fR
.PP
3260 3261 3262 3263 3264 3265 3266
\fB-readtimeout\fR \fIn\fR
.IP
Set libvncserver rfbMaxClientWait to n seconds. On
slow links that take a long time to paint the first
screen libvncserver may hit the timeout and drop the
connection.  Default: 20 seconds.
.PP
3267
\fB-nap,\fR \fB-nonap\fR
3268
.IP
3269 3270 3271
Monitor activity and if it is low take longer naps
between screen polls to really cut down load when idle.
Default: take naps
3272
.PP
3273 3274 3275 3276 3277 3278
\fB-sb\fR \fItime\fR
.IP
Time in seconds after NO activity (e.g. screen blank)
to really throttle down the screen polls (i.e. sleep
for about 1.5 secs). Use 0 to disable.  Default: 60
.PP
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298
\fB-nofbpm,\fR \fB-fbpm\fR
.IP
If the system supports the FBPM (Frame Buffer Power
Management) extension (i.e. some Sun systems), then
prevent the video h/w from going into a reduced power
state when VNC clients are connected.
.IP
FBPM capable video h/w save energy when the workstation
is idle by going into low power states (similar to DPMS
for monitors).  This interferes with x11vnc's polling
of the framebuffer data.
.IP
"\fB-nofbpm\fR" means prevent FBPM low power states whenever
VNC clients are connected, while "\fB-fbpm\fR" means to not
monitor the FBPM state at all.  See the 
.IR xset (1)
manpage
for details.  \fB-nofbpm\fR is basically the same as running
"xset fbpm force on" periodically.  Default: \fB-fbpm\fR
.PP
3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323
\fB-nodpms,\fR \fB-dpms\fR
.IP
If the system supports the DPMS (Display Power Management
Signaling) extension, then prevent the monitor from
going into a reduced power state when VNC clients
are connected.
.IP
DPMS reduced power monitor states are a good thing
and you normally want the power down to take place
(usually x11vnc has no problem exporting the display in
this state).  You probably only want to use "\fB-nodpms\fR"
to work around problems with Screen Savers kicking
on in DPMS low power states.  There is known problem
with kdesktop_lock on KDE where the screen saver keeps
kicking in every time user input stops for a second
or two.  Specifying "\fB-nodpms\fR" works around it.
.IP
"\fB-nodpms\fR" means prevent DPMS low power states whenever
VNC clients are connected, while "\fB-dpms\fR" means to not
monitor the DPMS state at all.  See the 
.IR xset (1)
manpage
for details.  \fB-nodpms\fR is basically the same as running
"xset dpms force on" periodically.  Default: \fB-dpms\fR
.PP
3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355
\fB-forcedpms\fR
.IP
If the system supports the DPMS (Display Power
Management Signaling) extension, then try to keep the
monitor in a powered off state.  This is to prevent
nosey people at the physical display from viewing
what is on the screen.  Be sure lock the screen before
disconnecting.
.IP
This method is far from bullet proof, e.g. suppose
someone attaches a non-DPMS monitor, or loads the
machine so that there is a gap of time before x11vnc
restores the powered off state?  On many machines if
he floods it with keyboard and mouse input he can see
flashes of what is on the screen before the DPMS off
state is reestablished.  For this to work securely
there would need to be support in the X server to do
this exactly rather than approximately with DPMS.
.PP
\fB-clientdpms\fR
.IP
As \fB-forcedpms\fR but only when VNC clients are connected.
.PP
\fB-noserverdpms\fR
.IP
The UltraVNC ServerInput extension is supported.
This allows the VNC viewer to click a button that will
cause the server (x11vnc) to try to disable keyboard
and mouse input at the physical display and put the
monitor in dpms powered off state.  Use this option to
skip powering off the monitor.
.PP
3356 3357 3358 3359 3360 3361
\fB-noultraext\fR
.IP
Disable the following UltraVNC extensions: SingleWindow
and ServerInput.  The others managed by libvncserver
(textchat, 1/n scaling, rfbEncodingUltra) are not.
.PP
3362 3363 3364
\fB-noxdamage\fR
.IP
Do not use the X DAMAGE extension to detect framebuffer
3365 3366
changes even if it is available.  Use \fB-xdamage\fR if your
default is to have it off.
3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399
.IP
x11vnc's use of the DAMAGE extension: 1) significantly
reduces the load when the screen is not changing much,
and 2) detects changed areas (small ones by default)
more quickly.
.IP
Currently the DAMAGE extension is overly conservative
and often reports large areas (e.g. a whole terminal
or browser window) as damaged even though the actual
changed region is much smaller (sometimes just a few
pixels).  So heuristics were introduced to skip large
areas and use the damage rectangles only as "hints"
for the traditional scanline polling.  The following
tuning parameters are introduced to adjust this
behavior:
.PP
\fB-xd_area\fR \fIA\fR
.IP
Set the largest DAMAGE rectangle area \fIA\fR (in
pixels: width * height) to trust as truly damaged:
the rectangle will be copied from the framebuffer
(slow) no matter what.  Set to zero to trust *all*
rectangles. Default: 20000
.PP
\fB-xd_mem\fR \fIf\fR
.IP
Set how long DAMAGE rectangles should be "remembered",
\fIf\fR is a floating point number and is in units of the
scanline repeat cycle time (32 iterations).  The default
(1.0) should give no painting problems. Increase it if
there are problems or decrease it to live on the edge
(perhaps useful on a slow machine).
.PP
3400 3401 3402 3403 3404 3405
\fB-sigpipe\fR \fIstring\fR
.IP
Broken pipe (SIGPIPE) handling.  \fIstring\fR can be
"ignore" or "exit".  For "ignore" libvncserver
will handle the abrupt loss of a client and continue,
for "exit" x11vnc will cleanup and exit at the 1st
3406 3407 3408 3409 3410 3411 3412
broken connection.
.IP
This option is not really needed since libvncserver
is doing the correct thing now for quite some time.
However, for convenience you can use it to ignore other
signals, e.g. "\fB-sigpipe\fR \fIignore:HUP,INT,TERM\fR" in case
that would be useful for some sort of application.
runge's avatar
runge committed
3413 3414 3415 3416
You can also put "exit:.." in the list to have x11vnc
cleanup on the listed signals. "\fB-sig\fR" is an alias
for this option if you don't like the 'pipe'. Example:
\fB-sig\fR ignore:INT,TERM,exit:USR1
3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443
.PP
\fB-threads,\fR \fB-nothreads\fR
.IP
Whether or not to use the threaded libvncserver
algorithm [rfbRunEventLoop] if libpthread is available
Default: \fB-nothreads\fR
.PP
\fB-fs\fR \fIf\fR
.IP
If the fraction of changed tiles in a poll is greater
than f, the whole screen is updated.  Default: 0.75
.PP
\fB-gaps\fR \fIn\fR
.IP
Heuristic to fill in gaps in rows or cols of n or
less tiles.  Used to improve text paging.  Default: 4
.PP
\fB-grow\fR \fIn\fR
.IP
Heuristic to grow islands of changed tiles n or wider
by checking the tile near the boundary.  Default: 3
.PP
\fB-fuzz\fR \fIn\fR
.IP
Tolerance in pixels to mark a tiles edges as changed.
Default: 2
.PP
3444 3445 3446 3447
\fB-debug_tiles\fR
.IP
Print debugging output for tiles, fb updates, etc.
.PP
3448 3449
\fB-snapfb\fR
.IP
3450 3451 3452 3453 3454 3455 3456 3457 3458 3459
Instead of polling the X display framebuffer (fb)
for changes, periodically copy all of X display fb
into main memory and examine that copy for changes.
(This setting also applies for non-X \fB-rawfb\fR modes).
Under some circumstances this will improve interactive
response, or at least make things look smoother, but in
others (most!) it will make the response worse.  If the
video h/w fb is such that reading small tiles is very
slow this mode could help.  To keep the "framerate"
up the screen size x bpp cannot be too large.  Note that
3460 3461 3462
this mode is very wasteful of memory I/O resources
(it makes full screen copies even if nothing changes).
It may be of use in video capture-like applications,
3463
webcams, or where window tearing is a problem.
3464
.PP
3465 3466
\fB-rawfb\fR \fIstring\fR
.IP
3467 3468
Instead of polling X, poll the memory object specified
in \fIstring\fR.
3469
.IP
3470
For file polling to memory map 
3471 3472
.IR mmap (2)
a file use:
3473 3474 3475 3476 3477 3478
"map:/path/to/a/file@WxHxB", with framebuffer Width,
Height, and Bits per pixel.  "mmap:..." is the
same.
.IP
If there is trouble with mmap, use  "file:/..."
for slower 
3479
.IR lseek (2)
3480 3481 3482 3483 3484 3485 3486 3487 3488 3489
based reading.  Use "snap:..."
to imply \fB-snapfb\fR mode and the "file:" access (this
is for devices that only provide the fb all at once).
.IP
For shared memory segments string is of the form:
"shm:N@WxHxB" which specifies a shmid N and with
WxHxB as above.  See 
.IR shmat (1)
and 
.IR ipcs (1)
3490 3491 3492 3493
.IP
If you do not supply a type "map" is assumed if
the file exists (see the next paragraphs for some
exceptions to this.)
3494
.IP
3495 3496 3497 3498 3499 3500
If string is "setup:cmd", then the command "cmd"
is run and the first line from it is read and used
as \fIstring\fR.  This allows initializing the device,
determining WxHxB, etc. These are often done as root
so take care.
.IP
3501
If the string begins with "video", see the VIDEO4LINUX
3502 3503 3504
discusion below where the device may be queried for
(and possibly set) the framebuffer parameters.
.IP
3505
If the string begins with "console", "/dev/fb", or
3506 3507 3508
"fb", see the LINUX CONSOLE discussion below where
the framebuffer device is opened and keystrokes (and
possibly mouse events) are inserted into the console.
3509
.IP
3510 3511 3512 3513
If the string begins with "vnc", see the VNC HOST
discussion below where the framebuffer is taken as that
of another remote VNC server.
.IP
3514 3515 3516 3517 3518
Optional suffixes are ":R/G/B" and "+O" to specify
red, green, and blue masks and an offset into the
memory object.  If the masks are not provided x11vnc
guesses them based on the bpp.
.IP
3519
Another optional suffix is the Bytes Per Line which in
3520
some cases is not WxB/4.  Specify it as WxHxB-BPL
3521 3522 3523
e.g. 800x600x16-2048.  This could be a normal width
1024 at 16bpp fb, but only width 800 shows up.
.IP
3524
Examples:
3525
.IP
3526
\fB-rawfb\fR shm:210337933@800x600x32:ff/ff00/ff0000
3527
.IP
3528
\fB-rawfb\fR map:/dev/fb0@1024x768x32
3529
.IP
3530
\fB-rawfb\fR map:/tmp/Xvfb_screen0@640x480x8+3232
3531
.IP
3532 3533
\fB-rawfb\fR file:/tmp/my.pnm@250x200x24+37
.IP
3534 3535 3536 3537 3538
\fB-rawfb\fR file:/dev/urandom@128x128x8
\fB-rawfb\fR snap:/dev/video0@320x240x24 \fB-24to32\fR
\fB-rawfb\fR video0
\fB-rawfb\fR video \fB-pipeinput\fR VID
\fB-rawfb\fR console
3539
\fB-rawfb\fR vnc:somehost:0
3540
.IP
3541 3542 3543 3544 3545 3546
(see 
.IR ipcs (1)
and 
.IR fbset (1)
for the first two examples)
.IP
3547 3548 3549 3550 3551 3552
In general all user input is discarded by default (see
the \fB-pipeinput\fR option for how to use a helper program
to insert).  Most of the X11 (screen, keyboard, mouse)
options do not make sense and many will cause this
mode to crash, so please think twice before setting or
changing them in a running x11vnc.
3553 3554 3555 3556 3557 3558 3559 3560 3561 3562
.IP
If you DO NOT want x11vnc to close the X DISPLAY in
rawfb mode, prepend a "+" e.g. +file:/dev/fb0...
Keeping the display open enables the default
remote-control channel, which could be useful.
Alternatively, if you specify \fB-noviewonly,\fR then the
mouse and keyboard input are STILL sent to the X
display, this usage should be very rare, i.e. doing
something strange with /dev/fb0.
.IP
3563 3564 3565 3566 3567
If the device is not "seekable" (e.g. webcam) try
reading it all at once in full snaps via the "snap:"
mode (note: this is a resource hog).  If you are using
file: or map: and the device needs to be reopened for
*every* snapfb snapshot, set the environment variable:
3568 3569 3570
SNAPFB_RAWFB_RESET=1 as well.
.IP
If you want x11vnc to dynamically transform a 24bpp
3571 3572 3573
rawfb to 32bpp (note that this will be slower) also
supply the \fB-24to32\fR option.  This would be useful for,
say, a video camera that delivers the pixel data as
3574 3575 3576
24bpp packed RGB.  This is the default under "video"
mode if the bpp is 24.
.IP
3577
VIDEO4LINUX: on Linux some attempt is made to handle
3578
video devices (webcams or TV tuners) automatically.
3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626
The idea is the WxHxB will be extracted from the
device itself.  So if you do not supply "@WxHxB...
parameters x11vnc will try to determine them.  It first
tries the v4l API if that support has been compiled in.
Otherwise it will run the v4l-
.IR info (1)
external program
if it is available.
.IP
The simplest examples are "\fB-rawfb\fR \fIvideo\fR" and "-rawfb
video1" which imply the device file /dev/video and
/dev/video1, respectively.  You can also supply the
/dev if you like, e.g. "\fB-rawfb\fR \fI/dev/video0\fR"
.IP
Since the video capture device framebuffer usually
changes continuously (e.g. brightness fluctuations),
you may want to use the \fB-wait,\fR \fB-slow_fb,\fR or \fB-defer\fR
options to lower the "framerate" to cut down on
network VNC traffic.
.IP
A more sophisticated video device scheme allows
initializing the device's settings using:
.IP
\fB-rawfb\fR video:<settings>
.IP
The prefix could also be, as above, e.g. "video1:" to
specify the device file.  The v4l API must be available
for this to work.  Otherwise, you will need to try
to initialize the device with an external program,
e.g. xawtv, spcaview, and hope they persist when x11vnc
re-opens the device.
.IP
<settings> is a comma separated list of key=value pairs.
The device's brightness, color, contrast, and hue can
be set to percentages, e.g. br=80,co=50,cn=44,hu=60.
.IP
The device filename can be set too if needed (if it
does not start with "video"), e.g. fn=/dev/qcam.
.IP
The width, height and bpp of the framebuffer can be
set via, e.g., w=160,h=120,bpp=16.
.IP
Related to the bpp above, the pixel format can be set
via the fmt=XXX, where XXX can be one of: GREY, HI240,
RGB555, RGB565, RGB24, and RGB32 (with bpp 8, 8, 16, 16,
24, and 32 respectively).  See http://www.linuxtv.org
for more info (V4L api).
.IP
3627
For TV/rf tuner cards one can set the tuning mode
3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656
via tun=XXX where XXX can be one of PAL, NTSC, SECAM,
or AUTO.
.IP
One can switch the input channel by the inp=XXX setting,
where XXX is the name of the input channel (Television,
Composite1, S-Video, etc).  Use the name that is in the
information about the device that is printed at startup.
.IP
For input channels with tuners (e.g. Television) one
can change which station is selected by the sta=XXX
setting.  XXX is the station number.  Currently only
the ntsc-cable-us (US cable) channels are built into
x11vnc.  See the \fB-freqtab\fR option below to supply one
from xawtv. If XXX is greater than 500, then it is
interpreted as a raw frequency in KHz.
.IP
Example:
.IP
\fB-rawfb\fR video:br=80,w=320,h=240,fmt=RGB32,tun=NTSC,sta=47
.IP
one might need to add inp=Television too for the input
channel to be TV if the card doesn't come up by default
in that one.
.IP
Note that not all video capture devices will support
all of the above settings.
.IP
See the \fB-pipeinput\fR VID option below for a way to control
the settings through the VNC Viewer via keystrokes.
3657 3658
As a shortcut, if the string begins "Video.." instead
of "video.." then \fB-pipeinput\fR VID is implied.
3659 3660 3661 3662 3663 3664
.IP
As above, if you specify a "@WxHxB..." after the
<settings> string they are used verbatim: the device
is not queried for the current values.  Otherwise the
device will be queried.
.IP
3665 3666 3667 3668
LINUX CONSOLE:  If the libvncserver LinuxVNC program
is on your system you may want to use that instead of
the following method because it will be faster and more
accurate for Linux text console.
3669
.IP
3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689
If the rawfb string begins with "console" the
framebuffer device /dev/fb0 is opened (this requires
the appropriate kernel modules to be installed) and so
is /dev/tty0.  The latter is used to inject keystrokes
(not all are supported, but the basic ones are).
You will need to be root to inject keystrokes.
/dev/tty0 refers to the active VT, to indicate one
explicitly, use "console2", etc. using the VT number.
.IP
If the Linux version seems to be 2.6 or later and the
"uinput" module appears to be present, then the uinput
method will be used instead of /dev/ttyN.  uinput allows
insertion of BOTH keystrokes and mouse input and so it
preferred when accessing graphical (e.g. QT-embedded)
linux console apps.  See \fB-pipeinput\fR UINPUT below for
more information on this mode; you will have to use
\fB-pipeinput\fR if you want to tweak any UINPUT parameters.
You may also want to also use the \fB-nodragging\fR and
\fB-cursor\fR none options.  Use "console0", etc  or
\fB-pipeinput\fR CONSOLE to force the /dev/ttyN method.
3690 3691
.IP
Note you can change VT remotely using the 
3692
.IR chvt (1)
3693 3694 3695
command.  Sometimes switching out and back corrects
the framebuffer state.
.IP
3696
To skip input injecting entirely use "consolex".
3697
.IP
3698 3699 3700 3701 3702
The string "/dev/fb0" (1, etc.) can be used instead
of "console".  This can be used to specify a different
framebuffer device, e.g. /dev/fb1.  As a shortcut the
"/dev/" can be dropped.  If the name is something
nonstandard, use "console:/dev/foofb"
3703 3704
.IP
If you do not want x11vnc to guess the framebuffer's
3705
WxHxB and masks automatically (sometimes the kernel
runge's avatar
runge committed
3706
gives inaccurate information), specify them with a
3707
@WxHxB at the end of the string.
3708
.IP
3709
Examples:
3710
\fB-rawfb\fR console
3711
\fB-rawfb\fR /dev/fb0           (same)
3712 3713
\fB-rawfb\fR console3           (force /dev/tty3)
\fB-rawfb\fR consolex           (no keystrokes or mouse)
3714
\fB-rawfb\fR console:/dev/nonstd
3715
\fB-rawfb\fR console \fB-pipeinput\fR UINPUT:accel=4.0
3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753
.IP
VNC HOST: if the \fB-rawfb\fR string is of the form
"vnc:host:N" then the VNC display "N" on the remote
VNC server "host" is connected to (i.e. x11vnc acts as
a VNC client itself) and that framebuffer is exported.
.IP
This mode is really only of use if you are trying
to improve performance in the case of many (e.g. >
10) simultaneous VNC viewers, and you try a divide
and conquer scheme to reduce bandwidth and improve
responsiveness.
.IP
For example, if there will be 64 simultaneous VNC
viewers this can lead to a lot of redundant VNC traffic
to and from the server host:N, extra CPU usage,
and all viewers response can be reduced by having
to wait for writes to the slowest client to finish.
However, if you set up 8 reflectors/repeaters started
with option \fB-rawfb\fR vnc:host:N, then there are only
8 connections to host:N.  Each repeater then handles
8 vnc viewer connections thereby spreading the load
around.  In classroom broadcast usage, try to put the
repeaters on different switches.  This mode is the same
as \fB-reflect\fR host:N.  Replace "host:N" by "listen"
or "listen:port" for a reverse connection.
.IP
Overall performance will not be as good as a single
direct connection because, among other things,
there is an additional level of framebuffer polling
and pointer motion can still induce many changes per
second that must be propagated.  Tip: if the remote VNC
is x11vnc doing wireframing, or an X display that does
wireframing that gives much better response than opaque
window dragging.  Consider the \fB-nodragging\fR option if
the problem is severe.
.IP
The VNC HOST mode implies \fB-shared.\fR  Use \fB-noshared\fR as
a subsequent cmdline option to disable sharing.
3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765
.PP
\fB-freqtab\fR \fIfile\fR
.IP
For use with "\fB-rawfb\fR \fIvideo\fR" for TV tuner devices to
specify station frequencies.  Instead of using the built
in ntsc-cable-us mapping of station number to frequency,
use the data in file.  For stations that are not
numeric, e.g. SE20, they are placed above the highest
numbered station in the order they are found.  Example:
"\fB-freqtab\fR \fI/usr/X11R6/share/xawtv/europe-west.list\fR"
You can make your own freqtab by copying the xawtv
format.
3766 3767 3768
.PP
\fB-pipeinput\fR \fIcmd\fR
.IP
3769 3770 3771 3772 3773 3774 3775 3776 3777 3778
This option lets you supply an external command in
\fIcmd\fR that x11vnc will pipe all of the user input
events to in a simple format.  In \fB-pipeinput\fR mode by
default x11vnc will not process any of the user input
events.  If you prefix \fIcmd\fR with "tee:" it will
both send them to the pipe command and process them.
For a description of the format run "-pipeinput
tee:/bin/cat".  Another prefix is "reopen" which
means to reopen pipe if it exits.  Separate multiple
prefixes with commas.
3779 3780 3781 3782 3783 3784
.IP
In combination with \fB-rawfb\fR one might be able to
do amusing things (e.g. control non-X devices).
To facilitate this, if \fB-rawfb\fR is in effect then the
value is stored in X11VNC_RAWFB_STR for the pipe command
to use if it wants. Do 'env | grep X11VNC' for more.
3785
.IP
runge's avatar
runge committed
3786
Built-in pipeinput modes (no external program required):
3787
.IP
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802
If cmd is "VID" and you are using the \fB-rawfb\fR for a
video capture device, then an internal list of keyboard
mappings is used to set parameters of the video.
The mappings are:
.IP
"B" and "b" adjust the brightness up and down.
"H" and "h" adjust the hue.
"C" and "c" adjust the colour.
"N" and "n" adjust the contrast.
"S" and "s" adjust the size of the capture screen.
"I" and "i" cycle through input channels.
Up and Down arrows adjust the station (if a tuner)
F1, F2, ..., F6 will switch the video capture pixel
format to HI240, RGB565, RGB24, RGB32, RGB555, and
GREY respectively.  See \fB-rawfb\fR video for details.
3803
.IP
3804 3805 3806 3807
If cmd is "CONSOLE" or "CONSOLEn" where n
is a Linux console number, then the linux console
keystroke insertion to /dev/ttyN (see \fB-rawfb\fR console)
is performed.
3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835
.IP
If cmd begins with "UINPUT" then the Linux uinput
module is used to insert both keystroke and mouse events
to the Linux console (see \fB-rawfb\fR above).  This usually
is the /dev/input/uinput device file (you may need to
create it with "mknod /dev/input/uinput c 10 223"
and insert the module with "modprobe uinput".
.IP
The UINPUT mode currently only does US keyboards (a
scan code option may be added), and not all keysyms
are supported.
.IP
You may want to use the options \fB-cursor\fR none and
\fB-nodragging\fR in this mode.
.IP
Additional tuning options may be supplied via:
UINPUT:opt1,opt2,... (a comma separated list). If an
option begins with "/" it is taken as the uinput
device file.
.IP
Which uinput is injected can be controlled by an option
string made of the characters "K", "M", and "B"
(see the \fB-input\fR option), e.g. "KM" allows keystroke
and motion but not button clicks.
.IP
A UINPUT option of the form: accel=f, or accel=fx+fy
sets the mouse motion "acceleration".  This is used
to correct raw mouse relative motion into how much the
3836 3837 3838 3839 3840 3841
application cursor moves (x11vnc has no control over,
or knowledge of how the windowing application interprets
the raw mouse motions).  Typically the acceleration
for an X display is 2 (see xset "m" option).  "f"
is a floating point number, e.g. 3.0.  Use "fx+fy"
if you need to supply different corrections for x and y.
3842 3843
.IP
Note: the default acceleration is 2.0 since it seems
3844 3845
both X and qt-embedded often (but not always) use
this value.
3846 3847 3848 3849 3850 3851
.IP
Even with a correct accel setting the mouse position
will get out of sync (probably due to a mouse
"threshold" setting where the acceleration doe not
apply, set 
.IR xset (1)
3852
).  The option reset=N sets the
runge's avatar
runge committed
3853
number of ms (default 150) after which the cursor is
3854 3855 3856 3857 3858
attempted to be reset (by forcing the mouse to (0,
0) via small increments and then back out to (x, y)
in 1 jump), This correction seems to be needed but can
cause jerkiness or unexpected behavior with menus, etc.
Use reset=0 to disable.
3859
.IP
3860 3861 3862
If the uinput device has an absolute pointer (as opposed
to a normal mouse that is a relative pointer) you can
specify the option "abs".  Note that a touchpad
3863
on a laptop is an absolute device to some degree.
3864 3865 3866 3867 3868 3869
This (usually) avoids all the problems with mouse
acceleration.  If x11vnc has trouble deducing the size
of the device, use "abs=WxH".  Furthermore, if the
device is a touchscreen (assumed to have an absolute
pointer) use "touch" or "touch=WxH".
.IP
runge's avatar
runge committed
3870
If you set the env. var X11VNC_UINPUT_THRESHOLDS then
3871
the thresh=n mode will be enabled.  It is currently
runge's avatar
runge committed
3872 3873
not working well.  If |dx| <= thresh and |dy| < thresh
no acceleration is applied.  Use "thresh=+n" |dx| +
3874
|dy| < thresh to be used instead (X11?)
runge's avatar
runge committed
3875
.IP
3876
Example:
3877
\fB-pipeinput\fR UINPUT:accel=4.0 \fB-cursor\fR none
runge's avatar
runge committed
3878 3879 3880
.IP
You can also set the env. var X11VNC_UINPUT_DEBUG=1 or
higher to get debugging output for UINPUT mode.
3881
.PP
runge's avatar
runge committed
3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893
\fB-macnodim\fR
.IP
For the native Mac OS X server, disable dimming.
.PP
\fB-macnosleep\fR
.IP
For the native Mac OS X server, disable display sleep.
.PP
\fB-macnosaver\fR
.IP
For the native Mac OS X server, disable screensaver.
.PP
3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914
\fB-macnowait\fR
.IP
For the native Mac OS X server, do not wait for the
user to switch back to his display.
.PP
\fB-macwheel\fR \fIn\fR
.IP
For the native Mac OS X server, set the mouse wheel
speed to n (default 5).
.PP
\fB-macnoswap\fR
.IP
For the native Mac OS X server, do not swap mouse
buttons 2 and 3.
.PP
\fB-macnoresize\fR
.IP
For the native Mac OS X server, do not resize or reset
the framebuffer even if it is detected that the screen
resolution or depth has changed.
.PP
runge's avatar
runge committed
3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927
\fB-maciconanim\fR \fIn\fR
.IP
For the native Mac OS X server, set n to the number
of milliseconds that the window iconify/deiconify
animation takes.  In \fB-ncache\fR mode this value will be
used to skip the animation if possible. (default 400)
.PP
\fB-macmenu\fR
.IP
For the native Mac OS X server, in \fB-ncache\fR client-side
caching mode, try to cache pull down menus (not perfect
because they have animated fades, etc.)
.PP
3928 3929 3930 3931 3932
\fB-gui\fR \fI[gui-opts]\fR
.IP
Start up a simple tcl/tk gui based on the the remote
control options \fB-remote/-query\fR described below.
Requires the "wish" program to be installed on the
3933 3934 3935 3936
machine.  "gui-opts" is not required: the default
is to start up both the full gui and x11vnc with the
gui showing up on the X display in the environment
variable DISPLAY.
3937 3938
.IP
"gui-opts" can be a comma separated list of items.
3939 3940 3941 3942
Currently there are these types of items: 1) a gui
mode, a 2) gui "simplicity", 3) the X display the
gui should display on, 4) a "tray" or "icon" mode,
and 5) a gui geometry.
3943 3944
.IP
1) The gui mode can be "start", "conn", or "wait"
3945 3946 3947 3948 3949 3950 3951
"start" is the default mode above and is not required.
"conn" means do not automatically start up x11vnc,
but instead just try to connect to an existing x11vnc
process.  "wait" means just start the gui and nothing
else (you will later instruct the gui to start x11vnc
or connect to an existing one.)
.IP
3952 3953 3954 3955 3956 3957 3958 3959
2) The gui simplicity is off by default (a power-user
gui with all options is presented) To start with
something less daunting supply the string "simple"
("ez" is an alias for this).  Once the gui is
started you can toggle between the two with "Misc ->
simple_gui".
.IP
3) Note the possible confusion regarding the potentially
3960 3961 3962 3963 3964 3965 3966 3967 3968
two different X displays: x11vnc polls one, but you
may want the gui to appear on another.  For example, if
you ssh in and x11vnc is not running yet you may want
the gui to come back to you via your ssh redirected X
display (e.g. localhost:10).
.IP
If you do not specify a gui X display in "gui-opts"
then the DISPLAY environment variable and \fB-display\fR
option are tried (in that order).  Regarding the x11vnc
3969 3970 3971 3972 3973 3974
X display the gui will try to communication with, it
first tries \fB-display\fR and then DISPLAY.  For example,
"x11vnc \fB-display\fR :0 \fB-gui\fR otherhost:0", will remote
control an x11vnc polling :0 and display the gui on
otherhost:0 The "tray/icon" mode below reverses this
preference, preferring to display on the x11vnc display.
3975
.IP
3976 3977
4) When "tray" or "icon" is specified, the gui
presents itself as a small icon with behavior typical
3978
of a "system tray" or "dock applet".  The color
3979 3980 3981 3982 3983 3984 3985 3986 3987
of the icon indicates status (connected clients) and
there is also a balloon status.  Clicking on the icon
gives a menu from which properties, etc, can be set and
the full gui is available under "Advanced".  To be
fully functional, the gui mode should be "start"
(the default).
.IP
For "icon" the gui just a small standalone window.
For "tray" it will attempt to embed itself in the
3988
"system tray" if possible. If "=setpass" is appended then
3989 3990 3991 3992 3993 3994 3995
at startup the X11 user will be prompted to set the
VNC session password.  If =<hexnumber> is appended
that icon will attempt to embed itself in the window
given by hexnumber.  Use =noadvanced to disable the
full gui. (To supply more than one, use "+" sign).
E.g. \fB-gui\fR tray=setpass and \fB-gui\fR icon=0x3600028
.IP
3996 3997 3998 3999
Other modes: "full", the default and need not be
specified.  "\fB-gui\fR \fInone\fR", do not show a gui, useful
to override a ~/.x11vncrc setting, etc.
.IP
4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017
5) When "geom=+X+Y" is specified, that geometry
is passed to the gui toplevel.  This is the icon in
icon/tray mode, or the full gui otherwise.  You can
also specify width and height, i.e. WxH+X+Y, but it
is not recommended.  In "tray" mode the geometry is
ignored unless the system tray manager does not seem
to be running.  One could imagine using something like
"\fB-gui\fR \fItray,geom=+4000+4000\fR" with a display manager
to keep the gui invisible until someone logs in...
.IP
More icon tricks, "icon=minimal" gives an icon just
with the VNC display number.  You can also set the font
with "iconfont=...".  The following could be useful:
"\fB-gui\fR \fIicon=minimal,iconfont=5x8,geom=24x10+0-0\fR"
.IP
General examples of the \fB-gui\fR option: "x11vnc \fB-gui",\fR
"x11vnc \fB-gui\fR ez" "x11vnc \fB-gui\fR localhost:10",
"x11vnc \fB-gui\fR conn,host:0", "x11vnc \fB-gui\fR tray,ez"
4018
"x11vnc \fB-gui\fR tray=setpass"
4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036
.IP
If you do not intend to start x11vnc from the gui
(i.e. just remote control an existing one), then the
gui process can run on a different machine from the
x11vnc server as long as X permissions, etc. permit
communication between the two.
.PP
\fB-remote\fR \fIcommand\fR
.IP
Remotely control some aspects of an already running
x11vnc server.  "\fB-R\fR" and "\fB-r\fR" are aliases for
"\fB-remote\fR".  After the remote control command is
sent to the running server the 'x11vnc \fB-remote\fR ...'
command exits.  You can often use the \fB-query\fR command
(see below) to see if the x11vnc server processed your
\fB-remote\fR command.
.IP
The default communication channel is that of X
4037
properties (specifically X11VNC_REMOTE), and so this
4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054
command must be run with correct settings for DISPLAY
and possibly XAUTHORITY to connect to the X server
and set the property.  Alternatively, use the \fB-display\fR
and \fB-auth\fR options to set them to the correct values.
The running server cannot use the \fB-novncconnect\fR option
because that disables the communication channel.
See below for alternate channels.
.IP
For example: 'x11vnc \fB-remote\fR stop' (which is the same as
\'x11vnc \fB-R\fR stop') will close down the x11vnc server.
\'x11vnc \fB-R\fR shared' will enable shared connections, and
\'x11vnc \fB-R\fR scale:3/4' will rescale the desktop.
.IP
.IP
The following \fB-remote/-R\fR commands are supported:
.IP
stop            terminate the server, same as "quit"
4055
"exit" or "shutdown".
4056 4057
.IP
ping            see if the x11vnc server responds.
4058
Return is: ans=ping:<xdisplay>
4059 4060
.IP
blacken         try to push a black fb update to all
4061 4062 4063
clients (due to timings a client
could miss it). Same as "zero", also
"zero:x1,y1,x2,y2" for a rectangle.
4064 4065 4066 4067 4068 4069
.IP
refresh         send the entire fb to all clients.
.IP
reset           recreate the fb, polling memory, etc.
.IP
id:windowid     set \fB-id\fR window to "windowid". empty
4070
or "root" to go back to root window
4071 4072 4073
.IP
sid:windowid    set \fB-sid\fR window to "windowid"
.IP
4074 4075 4076 4077
waitmapped      wait until subwin is mapped.
.IP
nowaitmapped    do not wait until subwin is mapped.
.IP
4078 4079
clip:WxH+X+Y    set \fB-clip\fR mode to "WxH+X+Y"
.IP
4080 4081 4082 4083
flashcmap       enable  \fB-flashcmap\fR mode.
.IP
noflashcmap     disable \fB-flashcmap\fR mode.
.IP
4084 4085
shiftcmap:n     set \fB-shiftcmap\fR to n.
.IP
4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096
notruecolor     enable  \fB-notruecolor\fR mode.
.IP
truecolor       disable \fB-notruecolor\fR mode.
.IP
overlay         enable  \fB-overlay\fR mode (if applicable).
.IP
nooverlay       disable \fB-overlay\fR mode.
.IP
overlay_cursor  in \fB-overlay\fR mode, enable cursor drawing.
.IP
overlay_nocursor disable cursor drawing. same as
4097
nooverlay_cursor.
4098
.IP
4099 4100 4101 4102
8to24           enable  \fB-8to24\fR mode (if applicable).
.IP
no8to24         disable \fB-8to24\fR mode.
.IP
4103 4104
8to24_opts:str  set the \fB-8to24\fR opts to "str".
.IP
4105 4106 4107 4108
24to32          enable  \fB-24to32\fR mode (if applicable).
.IP
no24to32        disable \fB-24to32\fR mode.
.IP
4109 4110 4111 4112
visual:vis      set \fB-visual\fR to "vis"
.IP
scale:frac      set \fB-scale\fR to "frac"
.IP
4113 4114
scale_cursor:f  set \fB-scale_cursor\fR to "f"
.IP
4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126
viewonly        enable  \fB-viewonly\fR mode.
.IP
noviewonly      disable \fB-viewonly\fR mode.
.IP
shared          enable  \fB-shared\fR mode.
.IP
noshared        disable \fB-shared\fR mode.
.IP
forever         enable  \fB-forever\fR mode.
.IP
noforever       disable \fB-forever\fR mode.
.IP
4127
timeout:n       reset \fB-timeout\fR to n, if there are
4128 4129
currently no clients, exit unless one
connects in the next n secs.
4130
.IP
4131
tightfilexfer   enable  filetransfer for NEW clients.
4132
.IP
4133 4134 4135 4136 4137 4138 4139
notightfilexfer disable filetransfer for NEW clients.
.IP
ultrafilexfer   enable  filetransfer for clients.
.IP
noultrafilexfer disable filetransfer for clients.
.IP
rfbversion:n.m  set \fB-rfbversion\fR for new clients.
4140
.IP
4141 4142 4143 4144
http            enable  http client connections.
.IP
nohttp          disable http client connections.
.IP
4145 4146 4147 4148
deny            deny any new connections, same as "lock"
.IP
nodeny          allow new connections, same as "unlock"
.IP
4149 4150 4151 4152 4153 4154 4155 4156
avahi           enable  avahi service advertizing.
.IP
noavahi         disable avahi service advertizing.
.IP
mdns            enable  avahi service advertizing.
.IP
nomdns          disable avahi service advertizing.
.IP
4157
connect:host    do reverse connection to host, "host"
4158
may be a comma separated list of hosts
4159 4160 4161
or host:ports.  See \fB-connect.\fR  Passwords
required as with fwd connections.
See X11VNC_REVERSE_CONNECTION_NO_AUTH=1
4162 4163
.IP
disconnect:host disconnect any clients from "host"
4164 4165 4166 4167 4168
same as "close:host".  Use host
"all" to close all current clients.
If you know the client internal hex ID,
e.g. 0x3 (returned by "\fB-query\fR \fIclients\fR"
and RFB_CLIENT_ID) you can use that too.
4169 4170
.IP
allowonce:host  For the next connection only, allow
4171
connection from "host".
4172 4173
.IP
allow:hostlist  set \fB-allow\fR list to (comma separated)
4174 4175 4176 4177
"hostlist". See \fB-allow\fR and \fB-localhost.\fR
Do not use with \fB-allow\fR /path/to/file
Use "+host" to add a single host, and
use "\fB-host\fR" to delete a single host
4178 4179 4180 4181 4182
.IP
localhost       enable  \fB-localhost\fR mode
.IP
nolocalhost     disable \fB-localhost\fR mode
.IP
runge's avatar
runge committed
4183 4184
listen:str      set \fB-listen\fR to str, empty to disable.
.IP
4185 4186 4187 4188
nolookup        enable  \fB-nolookup\fR mode.
.IP
lookup          disable \fB-nolookup\fR mode.
.IP
4189 4190
input:str       set \fB-input\fR to "str", empty to disable.
.IP
4191 4192 4193 4194 4195 4196 4197 4198
grabkbd         enable  \fB-grabkbd\fR mode.
.IP
nograbkbd       disable \fB-grabkbd\fR mode.
.IP
grabptr         enable  \fB-grabptr\fR mode.
.IP
nograbptr       disable \fB-grabptr\fR mode.
.IP
4199 4200 4201 4202
grabalways      enable  \fB-grabalways\fR mode.
.IP
nograbalways    disable \fB-grabalways\fR mode.
.IP
4203
client_input:str set the K, M, B \fB-input\fR on a per-client
4204 4205 4206
basis.  select which client as for
disconnect, e.g. client_input:host:MB
or client_input:0x2:K
4207
.IP
4208 4209
accept:cmd      set \fB-accept\fR "cmd" (empty to disable).
.IP
runge's avatar
runge committed
4210 4211
afteraccept:cmd set \fB-afteraccept\fR (empty to disable).
.IP
4212 4213 4214 4215 4216 4217 4218
gone:cmd        set \fB-gone\fR "cmd" (empty to disable).
.IP
noshm           enable  \fB-noshm\fR mode.
.IP
shm             disable \fB-noshm\fR mode (i.e. use shm).
.IP
flipbyteorder   enable \fB-flipbyteorder\fR mode, you may need
4219
to set noshm for this to do something.
4220 4221 4222 4223
.IP
noflipbyteorder disable \fB-flipbyteorder\fR mode.
.IP
onetile         enable  \fB-onetile\fR mode. (you may need to
4224
set shm for this to do something)
4225 4226 4227
.IP
noonetile       disable \fB-onetile\fR mode.
.IP
4228 4229 4230 4231 4232 4233
solid           enable  \fB-solid\fR mode
.IP
nosolid         disable \fB-solid\fR mode.
.IP
solid_color:color set \fB-solid\fR color (and apply it).
.IP
4234
blackout:str    set \fB-blackout\fR "str" (empty to disable).
4235 4236 4237 4238
See \fB-blackout\fR for the form of "str"
(basically: WxH+X+Y,...)
Use "+WxH+X+Y" to append a single
rectangle use "-WxH+X+Y" to delete one
4239 4240 4241 4242 4243
.IP
xinerama        enable  \fB-xinerama\fR mode. (if applicable)
.IP
noxinerama      disable \fB-xinerama\fR mode.
.IP
4244
xtrap           enable  \fB-xtrap\fR input mode(if applicable)
4245 4246 4247
.IP
noxtrap         disable \fB-xtrap\fR input mode.
.IP
4248 4249 4250 4251 4252 4253
xrandr          enable  \fB-xrandr\fR mode. (if applicable)
.IP
noxrandr        disable \fB-xrandr\fR mode.
.IP
xrandr_mode:mode set the \fB-xrandr\fR mode to "mode".
.IP
runge's avatar
runge committed
4254 4255
rotate:mode     set the \fB-rotate\fR mode to "mode".
.IP
4256
padgeom:WxH     set \fB-padgeom\fR to WxH (empty to disable)
4257 4258
If WxH is "force" or "do" the padded
geometry fb is immediately applied.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271
.IP
quiet           enable  \fB-quiet\fR mode.
.IP
noquiet         disable \fB-quiet\fR mode.
.IP
modtweak        enable  \fB-modtweak\fR mode.
.IP
nomodtweak      enable  \fB-nomodtweak\fR mode.
.IP
xkb             enable  \fB-xkb\fR modtweak mode.
.IP
noxkb           disable \fB-xkb\fR modtweak mode.
.IP
4272 4273 4274 4275 4276 4277 4278 4279
capslock        enable  \fB-capslock\fR mode.
.IP
nocapslock      disable \fB-capslock\fR mode.
.IP
skip_lockkeys   enable  \fB-skip_lockkeys\fR mode.
.IP
noskip_lockkeys disable \fB-skip_lockkeys\fR mode.
.IP
4280 4281
skip_keycodes:str enable \fB-xkb\fR \fB-skip_keycodes\fR "str".
.IP
4282 4283 4284 4285
sloppy_keys     enable  \fB-sloppy_keys\fR mode.
.IP
nosloppy_keys   disable \fB-sloppy_keys\fR mode.
.IP
4286 4287 4288 4289
skip_dups       enable  \fB-skip_dups\fR mode.
.IP
noskip_dups     disable \fB-skip_dups\fR mode.
.IP
4290 4291 4292
add_keysyms     enable \fB-add_keysyms\fR mode.
.IP
noadd_keysyms   stop adding keysyms. those added will
4293
still be removed at exit.
4294 4295 4296 4297 4298 4299 4300 4301 4302 4303
.IP
clear_mods      enable  \fB-clear_mods\fR mode and clear them.
.IP
noclear_mods    disable \fB-clear_mods\fR mode.
.IP
clear_keys      enable  \fB-clear_keys\fR mode and clear them.
.IP
noclear_keys    disable \fB-clear_keys\fR mode.
.IP
remap:str       set \fB-remap\fR "str" (empty to disable).
4304 4305 4306 4307
See \fB-remap\fR for the form of "str"
(basically: key1-key2,key3-key4,...)
Use "+key1-key2" to append a single
keymapping, use "-key1-key2" to delete.
4308 4309 4310 4311 4312
.IP
norepeat        enable  \fB-norepeat\fR mode.
.IP
repeat          disable \fB-norepeat\fR mode.
.IP
4313 4314 4315 4316
nofb            enable  \fB-nofb\fR mode.
.IP
fb              disable \fB-nofb\fR mode.
.IP
4317 4318 4319 4320 4321 4322
bell            enable  bell (if supported).
.IP
nobell          disable bell.
.IP
nosel           enable  \fB-nosel\fR mode.
.IP
4323
sel             disable \fB-nosel\fR mode.
4324 4325 4326
.IP
noprimary       enable  \fB-noprimary\fR mode.
.IP
4327 4328
primary         disable \fB-noprimary\fR mode.
.IP
4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340
nosetprimary    enable  \fB-nosetprimary\fR mode.
.IP
setprimary      disable \fB-nosetprimary\fR mode.
.IP
noclipboard     enable  \fB-noclipboard\fR mode.
.IP
clipboard       disable \fB-noclipboard\fR mode.
.IP
nosetclipboard  enable  \fB-nosetclipboard\fR mode.
.IP
setclipboard    disable \fB-nosetclipboard\fR mode.
.IP
4341 4342
seldir:str      set \fB-seldir\fR to "str"
.IP
4343 4344 4345 4346 4347
cursor:mode     enable  \fB-cursor\fR "mode".
.IP
show_cursor     enable  showing a cursor.
.IP
noshow_cursor   disable showing a cursor. (same as
4348
"nocursor")
4349
.IP
4350 4351 4352 4353
cursor_drag     enable  cursor changes during drag.
.IP
nocursor_drag   disable cursor changes during drag.
.IP
4354 4355
arrow:n         set \fB-arrow\fR to alternate n.
.IP
4356 4357 4358 4359
xfixes          enable  xfixes cursor shape mode.
.IP
noxfixes        disable xfixes cursor shape mode.
.IP
4360 4361 4362 4363 4364 4365 4366 4367
alphacut:n      set \fB-alphacut\fR to n.
.IP
alphafrac:f     set \fB-alphafrac\fR to f.
.IP
alpharemove     enable  \fB-alpharemove\fR mode.
.IP
noalpharemove   disable \fB-alpharemove\fR mode.
.IP
4368
alphablend      disable \fB-noalphablend\fR mode.
4369
.IP
4370
noalphablend    enable  \fB-noalphablend\fR mode.
4371
.IP
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389
cursorshape     disable \fB-nocursorshape\fR mode.
.IP
nocursorshape   enable  \fB-nocursorshape\fR mode.
.IP
cursorpos       disable \fB-nocursorpos\fR mode.
.IP
nocursorpos     enable  \fB-nocursorpos\fR mode.
.IP
xwarp           enable  \fB-xwarppointer\fR mode.
.IP
noxwarp         disable \fB-xwarppointer\fR mode.
.IP
buttonmap:str   set \fB-buttonmap\fR "str", empty to disable
.IP
dragging        disable \fB-nodragging\fR mode.
.IP
nodragging      enable  \fB-nodragging\fR mode.
.IP
runge's avatar
runge committed
4390 4391 4392 4393 4394 4395 4396 4397 4398 4399
ncache          reenable \fB-ncache\fR mode.
.IP
noncache        disable  \fB-ncache\fR mode.
.IP
ncache_size:n   set \fB-ncache\fR size to n.
.IP
ncache_cr       enable  \fB-ncache_cr\fR mode.
.IP
noncache_cr     disable \fB-ncache_cr\fR mode.
.IP
4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410
ncache_no_moveraise     enable  no_moveraise mode.
.IP
noncache_no_moveraise   disable no_moveraise mode.
.IP
ncache_no_dtchange      enable  ncache_no_dtchange mode.
.IP
noncache_no_dtchange    disable ncache_no_dtchange mode.
.IP
ncache_no_rootpixmap    enable  ncache_no_rootpixmap.
.IP
noncache_no_rootpixmap  disable ncache_no_rootpixmap.
4411
.IP
4412
ncache_reset_rootpixmap recheck the root pixmap
4413
.IP
4414 4415 4416 4417
ncache_keep_anims       enable  ncache_keep_anims.
.IP
noncache_keep_anims     disable ncache_keep_anims.
.IP
4418
wireframe       enable  \fB-wireframe\fR mode. same as "wf"
4419
.IP
4420
nowireframe     disable \fB-wireframe\fR mode. same as "nowf"
4421 4422 4423 4424 4425
.IP
wireframe:str   enable  \fB-wireframe\fR mode string.
.IP
wireframe_mode:str enable  \fB-wireframe\fR mode string.
.IP
4426 4427 4428 4429
wireframelocal  enable  wireframelocal. same as "wfl"
.IP
nowireframe     disable wireframelocal. same as "nowfl"
.IP
4430 4431 4432 4433 4434 4435 4436
wirecopyrect:str set \fB-wirecopyrect\fR string. same as "wcr:"
.IP
scrollcopyrect:str set \fB-scrollcopyrect\fR string. same "scr"
.IP
noscrollcopyrect disable \fB-scrollcopyrect__mode_.\fR "noscr"
.IP
scr_area:n      set \fB-scr_area\fR to n
4437
.IP
4438 4439 4440 4441 4442 4443
scr_skip:list   set \fB-scr_skip\fR to "list"
.IP
scr_inc:list    set \fB-scr_inc\fR to "list"
.IP
scr_keys:list   set \fB-scr_keys\fR to "list"
.IP
4444 4445
scr_term:list   set \fB-scr_term\fR to "list"
.IP
4446 4447
scr_keyrepeat:str set \fB-scr_keyrepeat\fR to "str"
.IP
4448 4449
scr_parms:str   set \fB-scr_parms\fR parameters.
.IP
4450 4451
fixscreen:str   set \fB-fixscreen\fR to "str".
.IP
4452 4453 4454 4455
noxrecord       disable all use of RECORD extension.
.IP
xrecord         enable  use of RECORD extension.
.IP
4456
reset_record    reset RECORD extension (if avail.)
4457
.IP
4458 4459 4460
pointer_mode:n  set \fB-pointer_mode\fR to n. same as "pm"
.IP
input_skip:n    set \fB-input_skip\fR to n.
4461
.IP
4462 4463 4464 4465
allinput        enable  use of \fB-allinput\fR mode.
.IP
noallinput      disable use of \fB-allinput\fR mode.
.IP
4466 4467
ssltimeout:n    set \fB-ssltimeout\fR to n.
.IP
4468
speeds:str      set \fB-speeds\fR to str.
4469
.IP
4470 4471
wmdt:str        set \fB-wmdt\fR to str.
.IP
4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483
debug_pointer   enable  \fB-debug_pointer,\fR same as "dp"
.IP
nodebug_pointer disable \fB-debug_pointer,\fR same as "nodp"
.IP
debug_keyboard   enable  \fB-debug_keyboard,\fR same as "dk"
.IP
nodebug_keyboard disable \fB-debug_keyboard,\fR same as "nodk"
.IP
defer:n         set \fB-defer\fR to n ms,same as deferupdate:n
.IP
wait:n          set \fB-wait\fR to n ms.
.IP
4484 4485 4486 4487 4488 4489
wait_ui:f       set \fB-wait_ui\fR factor to f.
.IP
wait_bog        disable \fB-nowait_bog\fR mode.
.IP
nowait_bog      enable  \fB-nowait_bog\fR mode.
.IP
4490 4491
slow_fb:f       set \fB-slow_fb\fR to f seconds.
.IP
4492
readtimeout:n   set read timeout to n seconds.
4493
.IP
4494 4495 4496 4497 4498 4499
nap             enable  \fB-nap\fR mode.
.IP
nonap           disable \fB-nap\fR mode.
.IP
sb:n            set \fB-sb\fR to n s, same as screen_blank:n
.IP
4500 4501 4502 4503
fbpm            disable \fB-nofbpm\fR mode.
.IP
nofbpm          enable  \fB-nofbpm\fR mode.
.IP
4504 4505 4506 4507
dpms            disable \fB-nodpms\fR mode.
.IP
nodpms          enable  \fB-nodpms\fR mode.
.IP
4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519
forcedpms       enable  \fB-forcedpms\fR mode.
.IP
noforcedpms     disable \fB-forcedpms\fR mode.
.IP
clientdpms      enable  \fB-clientdpms\fR mode.
.IP
noclientdpms    disable \fB-clientdpms\fR mode.
.IP
noserverdpms    enable  \fB-noserverdpms\fR mode.
.IP
serverdpms      disable \fB-noserverdpms\fR mode.
.IP
4520 4521 4522 4523
noultraext      enable  \fB-noultraext\fR mode.
.IP
ultraext        disable \fB-noultraext\fR mode.
.IP
4524 4525 4526 4527 4528 4529 4530 4531
xdamage         enable  xdamage polling hints.
.IP
noxdamage       disable xdamage polling hints.
.IP
xd_area:A       set \fB-xd_area\fR max pixel area to "A"
.IP
xd_mem:f        set \fB-xd_mem\fR remembrance to "f"
.IP
4532 4533 4534 4535 4536 4537 4538 4539
fs:frac         set \fB-fs\fR fraction to "frac", e.g. 0.5
.IP
gaps:n          set \fB-gaps\fR to n.
.IP
grow:n          set \fB-grow\fR to n.
.IP
fuzz:n          set \fB-fuzz\fR to n.
.IP
4540 4541 4542 4543
snapfb          enable  \fB-snapfb\fR mode.
.IP
nosnapfb        disable \fB-snapfb\fR mode.
.IP
4544 4545
rawfb:str       set \fB-rawfb\fR mode to "str".
.IP
4546 4547 4548 4549
uinput_accel:f  set uinput_accel to f.
.IP
uinput_reset:n  set uinput_reset to n ms.
.IP
runge's avatar
runge committed
4550 4551
uinput_always:n set uinput_always to 1/0.
.IP
4552
progressive:n   set libvncserver \fB-progressive\fR slice
4553
height parameter to n.
4554
.IP
4555 4556 4557 4558
desktop:str     set \fB-desktop\fR name to str for new clients.
.IP
rfbport:n       set \fB-rfbport\fR to n.
.IP
runge's avatar
runge committed
4559 4560 4561 4562
macnosaver      enable  \fB-macnosaver\fR mode.
.IP
macsaver        disable \fB-macnosaver\fR mode.
.IP
runge's avatar
runge committed
4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582
macnowait       enable  \fB-macnowait\fR  mode.
.IP
macwait         disable \fB-macnowait\fR  mode.
.IP
macwheel:n      set \fB-macwheel\fR to n.
.IP
macnoswap       enable  \fB-macnoswap\fR mouse button mode.
.IP
macswap         disable \fB-macnoswap\fR mouse button mode.
.IP
macnoresize     enable  \fB-macnoresize\fR mode.
.IP
macresize       disable \fB-macnoresize\fR mode.
.IP
maciconanim:n   set \fB-maciconanim\fR to n.
.IP
macmenu         enable  \fB-macmenu\fR  mode.
.IP
macnomenu       disable \fB-macnmenu\fR mode.
.IP
4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593
httpport:n      set \fB-httpport\fR to n.
.IP
httpdir:dir     set \fB-httpdir\fR to dir (and enable http).
.IP
enablehttpproxy   enable  \fB-enablehttpproxy\fR mode.
.IP
noenablehttpproxy disable \fB-enablehttpproxy\fR mode.
.IP
alwaysshared     enable  \fB-alwaysshared\fR mode.
.IP
noalwaysshared   disable \fB-alwaysshared\fR mode.
4594
(may interfere with other options)
4595 4596 4597 4598
.IP
nevershared      enable  \fB-nevershared\fR mode.
.IP
nonevershared    disable \fB-nevershared\fR mode.
4599
(may interfere with other options)
4600 4601 4602 4603
.IP
dontdisconnect   enable  \fB-dontdisconnect\fR mode.
.IP
nodontdisconnect disable \fB-dontdisconnect\fR mode.
4604
(may interfere with other options)
4605
.IP
4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621
debug_xevents   enable  debugging X events.
.IP
nodebug_xevents disable debugging X events.
.IP
debug_xdamage   enable  debugging X DAMAGE mechanism.
.IP
nodebug_xdamage disable debugging X DAMAGE mechanism.
.IP
debug_wireframe enable   debugging wireframe mechanism.
.IP
nodebug_wireframe disable debugging wireframe mechanism.
.IP
debug_scroll    enable  debugging scrollcopy mechanism.
.IP
nodebug_scroll  disable debugging scrollcopy mechanism.
.IP
4622 4623 4624 4625
debug_tiles     enable  \fB-debug_tiles\fR
.IP
nodebug_tiles   disable \fB-debug_tiles\fR
.IP
4626 4627 4628 4629
debug_grabs     enable  \fB-debug_grabs\fR
.IP
nodebug_grabs   disable \fB-debug_grabs\fR
.IP
4630 4631 4632 4633
debug_sel       enable  \fB-debug_sel\fR
.IP
nodebug_sel     disable \fB-debug_sel\fR
.IP
4634 4635 4636 4637
debug_ncache    enable  \fB-debug_ncache\fR
.IP
nodebug_ncache  disable \fB-debug_ncache\fR
.IP
4638 4639 4640 4641
dbg             enable  \fB-dbg\fR crash shell
.IP
nodbg           disable \fB-dbg\fR crash shell
.IP
4642
.IP
4643
noremote        disable the \fB-remote\fR command processing,
4644
it cannot be turned back on.
4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686
.IP
.IP
The 
.IR vncconnect (1)
command from standard VNC
.IP
distributions may also be used if string is prefixed
.IP
with "cmd=" E.g. 'vncconnect cmd=stop'.  Under some
.IP
circumstances 
.IR xprop (1)
can used if it supports \fB-set\fR
.IP
(see the FAQ).
.IP
.IP
If "\fB-connect\fR \fI/path/to/file\fR" has been supplied to the
.IP
running x11vnc server then that file can be used as a
.IP
communication channel (this is the only way to remote
.IP
control one of many x11vnc's polling the same X display)
.IP
Simply run: 'x11vnc \fB-connect\fR /path/to/file \fB-remote\fR ...'
.IP
or you can directly write to the file via something
.IP
like: "echo cmd=stop > /path/to/file", etc.
.PP
\fB-query\fR \fIvariable\fR
.IP
Like \fB-remote,\fR except just query the value of
\fIvariable\fR.  "\fB-Q\fR" is an alias for "\fB-query\fR".
Multiple queries can be done by separating variables
by commas, e.g. \fB-query\fR var1,var2. The results come
back in the form ans=var1:value1,ans=var2:value2,...
to the standard output.  If a variable is read-only,
it comes back with prefix "aro=" instead of "ans=".
.IP
Some \fB-remote\fR commands are pure actions that do not make
4687 4688 4689
sense as variables, e.g. "stop" or "disconnect", in
these cases the value returned is "N/A".  To direct a
query straight to the X11VNC_REMOTE property or connect
4690 4691
file use "qry=..." instead of "cmd=..."
.IP
4692 4693 4694 4695 4696
ans= stop quit exit shutdown ping blacken zero
refresh reset close disconnect id sid waitmapped
nowaitmapped clip flashcmap noflashcmap shiftcmap
truecolor notruecolor overlay nooverlay overlay_cursor
overlay_yescursor nooverlay_nocursor nooverlay_cursor
4697
nooverlay_yescursor overlay_nocursor 8to24 no8to24
4698 4699
8to24_opts 24to32 no24to32 visual scale scale_cursor
viewonly noviewonly shared noshared forever noforever
4700 4701
once timeout tightfilexfer notightfilexfer ultrafilexfer
noultrafilexfer rfbversion deny lock nodeny unlock
4702 4703 4704 4705 4706 4707 4708 4709 4710
avahi mdns noavahi nomdns connect allowonce allow
localhost nolocalhost listen lookup nolookup accept
afteraccept gone shm noshm flipbyteorder noflipbyteorder
onetile noonetile solid_color solid nosolid blackout
xinerama noxinerama xtrap noxtrap xrandr noxrandr
xrandr_mode rotate padgeom quiet q noquiet modtweak
nomodtweak xkb noxkb capslock nocapslock skip_lockkeys
noskip_lockkeys skip_keycodes sloppy_keys nosloppy_keys
skip_dups noskip_dups add_keysyms noadd_keysyms
4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729
clear_mods noclear_mods clear_keys noclear_keys
remap repeat norepeat fb nofb bell nobell sel nosel
primary noprimary setprimary nosetprimary clipboard
noclipboard setclipboard nosetclipboard seldir
cursorshape nocursorshape cursorpos nocursorpos
cursor_drag nocursor_drag cursor show_cursor
noshow_cursor nocursor arrow xfixes noxfixes xdamage
noxdamage xd_area xd_mem alphacut alphafrac alpharemove
noalpharemove alphablend noalphablend xwarppointer
xwarp noxwarppointer noxwarp buttonmap dragging
nodragging ncache_cr noncache_cr ncache_no_moveraise
noncache_no_moveraise ncache_no_dtchange
noncache_no_dtchange ncache_no_rootpixmap
noncache_no_rootpixmap ncache_reset_rootpixmap
ncache_keep_anims noncache_keep_anims ncache_old_wm
noncache_old_wm ncache noncache ncache_size debug_ncache
nodebug_ncache wireframe_mode wireframe wf nowireframe
nowf wireframelocal wfl nowireframelocal nowfl
wirecopyrect wcr nowirecopyrect nowcr scr_area
4730
scr_skip scr_inc scr_keys scr_term scr_keyrepeat
4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741
scr_parms scrollcopyrect scr noscrollcopyrect
noscr fixscreen noxrecord xrecord reset_record
pointer_mode pm input_skip allinput noallinput input
grabkbd nograbkbd grabptr nograbptr grabalways
nograbalways client_input ssltimeout speeds wmdt
debug_pointer dp nodebug_pointer nodp debug_keyboard
dk nodebug_keyboard nodk deferupdate defer wait_ui
wait_bog nowait_bog slow_fb wait readtimeout nap nonap
sb screen_blank fbpm nofbpm dpms nodpms clientdpms
noclientdpms forcedpms noforcedpms noserverdpms
serverdpms noultraext ultraext fs gaps grow fuzz snapfb
4742 4743 4744
nosnapfb rawfb uinput_accel uinput_thresh uinput_reset
uinput_always progressive rfbport http nohttp httpport
httpdir enablehttpproxy noenablehttpproxy alwaysshared
4745 4746 4747 4748 4749
noalwaysshared nevershared noalwaysshared dontdisconnect
nodontdisconnect desktop debug_xevents nodebug_xevents
debug_xevents debug_xdamage nodebug_xdamage
debug_xdamage debug_wireframe nodebug_wireframe
debug_wireframe debug_scroll nodebug_scroll debug_scroll
4750
debug_tiles dbt nodebug_tiles nodbt debug_tiles
4751
debug_grabs nodebug_grabs debug_sel nodebug_sel dbg
runge's avatar
runge committed
4752 4753 4754 4755
nodbg macnosaver macsaver nomacnosaver macnowait macwait
nomacnowait macwheel macnoswap macswap nomacnoswap
macnoresize macresize nomacnoresize maciconanim macmenu
macnomenu nomacmenu noremote
4756
.IP
4757 4758 4759
aro=  noop display vncdisplay desktopname guess_desktop
http_url auth xauth users rootshift clipshift
scale_str scaled_x scaled_y scale_numer scale_denom
4760
scale_fac scaling_blend scaling_nomult4 scaling_pad
4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771
scaling_interpolate inetd privremote unsafe safer
nocmds passwdfile unixpw unixpw_nis unixpw_list ssl
ssl_pem sslverify stunnel stunnel_pem https httpsredir
usepw using_shm logfile o flag rc norc h help V version
lastmod bg sigpipe threads readrate netrate netlatency
pipeinput clients client_count pid ext_xtest ext_xtrap
ext_xrecord ext_xkb ext_xshm ext_xinerama ext_overlay
ext_xfixes ext_xdamage ext_xrandr rootwin num_buttons
button_mask mouse_x mouse_y bpp depth indexed_color
dpy_x dpy_y wdpy_x wdpy_y off_x off_y cdpy_x cdpy_y
coff_x coff_y rfbauth passwd viewpasswd
4772 4773 4774 4775 4776 4777
.PP
\fB-QD\fR \fIvariable\fR
.IP
Just like \fB-query\fR variable, but returns the default
value for that parameter (no running x11vnc server
is consulted)
4778
.PP
4779 4780 4781 4782 4783
\fB-sync\fR
.IP
By default \fB-remote\fR commands are run asynchronously, that
is, the request is posted and the program immediately
exits.  Use \fB-sync\fR to have the program wait for an
4784 4785 4786
acknowledgement from the x11vnc server that command was
processed (somehow).  On the other hand \fB-query\fR requests
are always processed synchronously because they have
4787
to wait for the answer.
4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799
.IP
Also note that if both \fB-remote\fR and \fB-query\fR requests are
supplied on the command line, the \fB-remote\fR is processed
first (synchronously: no need for \fB-sync),\fR and then
the \fB-query\fR request is processed in the normal way.
This allows for a reliable way to see if the \fB-remote\fR
command was processed by querying for any new settings.
Note however that there is timeout of a few seconds so
if the x11vnc takes longer than that to process the
requests the requestor will think that a failure has
taken place.
.PP
4800
\fB-noremote,\fR \fB-yesremote\fR
4801 4802
.IP
Do not process any remote control commands or queries.
4803 4804
Do process remote control commands or queries.
Default: \fB-yesremote\fR
4805 4806
.IP
A note about security wrt remote control commands.
4807
If someone can connect to the X display and change
4808
the property X11VNC_REMOTE, then they can remotely
4809
control x11vnc.  Normally access to the X display is
4810
protected.  Note that if they can modify X11VNC_REMOTE
4811 4812
on the X server, they have enough permissions to also
run their own x11vnc and thus have complete control
4813
of the desktop.  If the  "\fB-connect\fR \fI/path/to/file\fR"
4814 4815 4816
channel is being used, obviously anyone who can write
to /path/to/file can remotely control x11vnc.  So be
sure to protect the X display and that file's write
4817
permissions.  See \fB-privremote\fR below.
4818 4819
.IP
If you are paranoid and do not think \fB-noremote\fR is
4820 4821 4822
enough, to disable the X11VNC_REMOTE property channel
completely use \fB-novncconnect,\fR or use the \fB-safer\fR option
that shuts many things off.
4823 4824 4825
.PP
\fB-unsafe\fR
.IP
4826 4827 4828 4829 4830 4831
A few remote commands are disabled by default
(currently: id:pick, accept:<cmd>, gone:<cmd>, and
rawfb:setup:<cmd>) because they are associated with
running external programs.  If you specify \fB-unsafe,\fR then
these remote-control commands are allowed.  Note that
you can still specify these parameters on the command
4832
line, they just cannot be invoked via remote-control.
4833 4834 4835
.PP
\fB-safer\fR
.IP
4836 4837 4838 4839 4840 4841
Equivalent to: \fB-novncconnect\fR \fB-noremote\fR and prohibiting
\fB-gui\fR and the \fB-connect\fR file. Shuts off communcation
channels.
.PP
\fB-privremote\fR
.IP
4842
Perform some sanity checks and disable remote-control
4843
commands if it appears that the X DISPLAY and/or
4844 4845
connectfile can be accessed by other users.  Once
remote-control is disabled it cannot be turned back on.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856
.PP
\fB-nocmds\fR
.IP
No external commands (e.g. 
.IR system (3)
, 
.IR popen (3)
, 
.IR exec (3)
)
will be run.
4857
.PP
4858 4859 4860 4861 4862 4863 4864 4865
\fB-allowedcmds\fR \fIlist\fR
.IP
\fIlist\fR contains a comma separated list of the only
external commands that can be run.  The full list of
associated options is:
.IP
stunnel, ssl, unixpw, WAIT, id, accept, afteraccept,
gone, pipeinput, v4l-info, rawfb-setup, dt, gui,
4866
storepasswd, passwdfile, custom_passwd, crash.
4867 4868 4869 4870 4871
.IP
See each option's help to learn the associated external
command.  Note that the \fB-nocmds\fR option takes precedence
and disables all external commands.
.PP
4872 4873 4874 4875 4876 4877
\fB-deny_all\fR
.IP
For use with \fB-remote\fR nodeny: start out denying all
incoming clients until "\fB-remote\fR \fInodeny\fR" is used to
let them in.
.PP
4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892
These options are passed to libvncserver:
.PP
\fB-rfbport\fR \fIport\fR
.IP
TCP port for RFB protocol
.PP
\fB-rfbwait\fR \fItime\fR
.IP
max time in ms to wait for RFB client
.PP
\fB-rfbauth\fR \fIpasswd-file\fR
.IP
use authentication on RFB protocol
(use 'storepasswd' to create a password file)
.PP
4893 4894 4895 4896 4897 4898 4899 4900
\fB-rfbversion\fR \fI3.x\fR
.IP
Set the version of the RFB we choose to advertise
.PP
\fB-permitfiletransfer\fR
.IP
permit file transfer support
.PP
4901 4902 4903 4904 4905 4906 4907 4908 4909
\fB-passwd\fR \fIplain-password\fR
.IP
use authentication
(use plain-password as password, USE AT YOUR RISK)
.PP
\fB-deferupdate\fR \fItime\fR
.IP
time in ms to defer updates (default 40)
.PP
4910 4911 4912 4913
\fB-deferptrupdate\fR \fItime\fR
.IP
time in ms to defer pointer updates (default none)
.PP
4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945
\fB-desktop\fR \fIname\fR
.IP
VNC desktop name (default "LibVNCServer")
.PP
\fB-alwaysshared\fR
.IP
always treat new clients as shared
.PP
\fB-nevershared\fR
.IP
never treat new clients as shared
.PP
\fB-dontdisconnect\fR
.IP
don't disconnect existing clients when a new non-shared
connection comes in (refuse new connection instead)
.PP
\fB-httpdir\fR \fIdir-path\fR
.IP
enable http server using dir-path home
.PP
\fB-httpport\fR \fIportnum\fR
.IP
use portnum for http connection
.PP
\fB-enablehttpproxy\fR
.IP
enable http proxy support
.PP
\fB-progressive\fR \fIheight\fR
.IP
enable progressive updating for slow links
runge's avatar
runge committed
4946 4947 4948 4949 4950
.PP
\fB-listen\fR \fIipaddr\fR
.IP
listen for connections only on network interface with
addr ipaddr. '-listen localhost' and hostname work too.
4951 4952 4953 4954 4955 4956 4957 4958 4959 4960
.PP
libvncserver-tight-extension options:
.PP
\fB-disablefiletransfer\fR
.IP
disable file transfer
.PP
\fB-ftproot\fR \fIstring\fR
.IP
set ftp root
4961 4962 4963 4964 4965 4966 4967 4968 4969
.SH "FILES"
.IR $HOME/.x11vncrc ,
.IR $HOME/.Xauthority
.SH "ENVIRONMENT"
.IR DISPLAY ,
.IR XAUTHORITY ,
.IR HOME
.PP
The following are set for the auxiliary commands
4970
run by \fB-accept\fR, \fB-gone\fR and other cases:
4971 4972 4973 4974 4975 4976 4977
.PP
.IR RFB_CLIENT_IP ,
.IR RFB_CLIENT_PORT ,
.IR RFB_SERVER_IP ,
.IR RFB_SERVER_PORT ,
.IR RFB_X11VNC_PID ,
.IR RFB_CLIENT_ID ,
4978 4979
.IR RFB_CLIENT_COUNT ,
.IR RFB_MODE
4980 4981 4982 4983 4984 4985
.IR RFB_STATE
.IR RFB_LOGIN_VIEWONLY
.IR RFB_LOGIN_TIME
.IR RFB_CURRENT_TIME
.IR RFB_USERNAME
.IR RFB_SSL_CLIENT_CERT
4986 4987 4988 4989 4990 4991 4992
.SH "SEE ALSO"
.IR vncviewer (1),
.IR vncpasswd (1),
.IR vncconnect (1),
.IR vncserver (1),
.IR Xvnc (1),
.IR xev (1),
4993 4994 4995
.IR xdpyinfo (1),
.IR xwininfo (1),
.IR xprop (1),
4996
.IR xmodmap (1),
4997
.IR xrandr (1),
4998 4999 5000 5001 5002
.IR Xserver (1),
.IR xauth (1),
.IR xhost (1),
.IR Xsecurity (7),
.IR xmessage (1),
5003
.IR XGetImage (3X11),
5004
.IR ipcrm (1),
5005 5006 5007 5008 5009 5010 5011
.IR inetd (1),
.IR xdm (1),
.IR gdm (1),
.IR kdm (1),
.IR ssh (1),
.IR stunnel (8),
.IR su (1),
5012 5013
.IR http://www.tightvnc.com ,
.IR http://www.realvnc.com ,
5014 5015
.IR http://www.karlrunge.com/x11vnc/ ,
.IR http://www.karlrunge.com/x11vnc/#faq
5016 5017 5018 5019 5020
.SH AUTHORS
x11vnc was written by Karl J. Runge <runge@karlrunge.com>,
it is part of the LibVNCServer project <http://sf.net/projects/libvncserver>.
This manual page is based one the one written by Ludovic Drolez
<ldrolez@debian.org>, for the Debian project (both may be used by others).