git.sesse.net Git - rdpsrv/blob - Xserver/programs/Xserver/Xvnc.man

   1 .TH Xvnc 1 "28 February 2003" "RealVNC Ltd" "Virtual Network Computing"
   2 .SH NAME
   3 Xvnc \- the X VNC server
   4 .SH SYNOPSIS
   5 .B Xvnc
   6 .RI [ options ]
   7 .RI : display#
   8 .SH DESCRIPTION
   9 .B Xvnc
  10 is the X VNC (Virtual Network Computing) server.  It is based on a standard X
  11 server, but it has a "virtual" screen rather than a physical one.  X
  12 applications display themselves on it as if it were a normal X display, but
  13 they can only be accessed via a VNC viewer - see \fBvncviewer\fP(1).
  14
  15 So Xvnc is really two servers in one. To the applications it is an X server,
  16 and to the remote VNC users it is a VNC server. By convention we have arranged
  17 that the VNC server display number will be the same as the X server display
  18 number, which means you can use eg. snoopy:2 to refer to display 2 on machine
  19 "snoopy" in both the X world and the VNC world.
  20
  21 The best way of starting \fBXvnc\fP is via the \fBvncserver\fP script.  This
  22 sets up the environment appropriately and runs some X applications to get you
  23 going.  See the manual page for \fBvncserver\fP(1) for more information.
  24
  25 .SH OPTIONS
  26 .B Xvnc
  27 takes lots of options - running \fBXvnc -help\fP gives a list.  Many of these
  28 are standard X server options, which are described in the \fBXserver\fP(1)
  29 manual page.
  30
  31 .TP
  32 .B \-geometry \fIwidth\fPx\fIheight\fP
  33 Specify the size of the desktop to be created. Default is 640x480.
  34
  35 .TP
  36 .B \-depth \fIdepth\fP
  37 Specify the pixel depth in bits of the desktop to be created. Default is 8,
  38 other possible values are 15, 16 and 24 - anything else is likely to cause
  39 strange behaviour by applications.
  40
  41 .TP
  42 .B \-pixelformat \fIformat\fP
  43 Specify pixel format for server to use (BGRnnn or RGBnnn).  The default for
  44 depth 8 is BGR233 (meaning the most significant two bits represent blue, the
  45 next three green, and the least significant three represent red), the default
  46 for depth 16 is RGB565 and for depth 24 is RGB888.
  47
  48 .TP
  49 .B \-cc 3
  50 As an alternative to the default TrueColor visual, this allows you to run an
  51 Xvnc server with a PseudoColor visual (i.e. one which uses a colour map or
  52 palette), which can be useful for running some old X applications which only
  53 work on such a display.  Note that viewing such a desktop can be painful
  54 because it usually results in a full-screen redraw every time an entry in the
  55 colour map changes.  Values other than 3 (PseudoColor) and 4 (TrueColor) for
  56 the \-cc option may result in strange behaviour, and PseudoColor desktops must
  57 be 8 bits deep.
  58
  59 .TP
  60 .B \-rfbport \fIport\fP
  61 Specifies the TCP port on which Xvnc listens for connections from viewers (the
  62 protocol used in VNC is called RFB - "remote framebuffer").  The default is
  63 5900 plus the display number.
  64
  65 .TP
  66 .B \-rfbwait \fItime\fP
  67 Time in milliseconds to wait for a viewer which is blocking Xvnc.  This is
  68 necessary because Xvnc is single-threaded and sometimes blocks until the viewer
  69 has finished sending or receiving a message - note that this does not mean an
  70 update will be aborted after this time.  Default is 20000 (20 seconds).
  71
  72 .TP
  73 .B \-nocursor
  74 Don't draw a cursor.  This can be useful when debugging a viewer to make the
  75 updates drawn more predictable.
  76
  77 .TP
  78 .B \-rfbauth \fIpasswd-file\fP
  79 Specifies the file containing the password used to authenticate viewers.  The
  80 file is accessed each time a connection comes in, so it can be changed on the
  81 fly via \fBvncpasswd\fP(1).
  82
  83 .TP
  84 .B \-httpd \fIdirectory\fP
  85 Run a mini-HTTP server which serves files from the given directory.  Normally
  86 the directory will contain the classes for the Java viewer.  In addition, files
  87 with a .vnc extension will have certain substitutions made so that a single
  88 installation of the Java VNC viewer can be served by separate instances of
  89 Xvnc.
  90
  91 .TP
  92 .B \-httpport \fIport\fP
  93 Specifies the port on which the mini-HTTP server runs.  Default is 5800 plus
  94 the display number.
  95
  96 .TP
  97 .B \-deferupdate \fItime\fP
  98 Xvnc uses a "deferred update" mechanism which enhances performance in many
  99 cases. After any change to the framebuffer, Xvnc waits for this number of
 100 milliseconds (default 40) before sending an update to any waiting clients. This
 101 means that more changes tend to get coalesced together in a single
 102 update. Setting it to 0 results in the same behaviour as earlier versions of
 103 Xvnc, where the first change to the framebuffer causes an immediate update to
 104 any waiting clients.
 105
 106 .TP
 107 .B \-economictranslate
 108 The server normally uses a lookup table for translating pixel values when the
 109 viewer requests a different format from the native one used by the server.
 110 This can use up to 256Kbytes per connected viewer, so if you have many viewers
 111 you may wish to specify this option which will save memory at the expense of a
 112 little bit of speed. Only relevant for 16-bit-deep desktops.
 113
 114 .TP
 115 .B \-maxrects \fInum\fP
 116 Sets the maximum number of rectangles Xvnc will send in one update.  If an
 117 update would consist of more than this many rectangles, then an update of a
 118 single bounding rectangle is sent instead.  This makes sense because sending a
 119 large number of small rectangles is less efficient than sending one large
 120 rectangle, even when this means updating pixels which haven't actually changed.
 121 The default is 50.
 122
 123 .TP
 124 .B \-desktop \fIdesktop-name\fP
 125 Each desktop has a name which may be displayed by the viewer. It defaults to
 126 "x11".
 127
 128 .TP
 129 .B \-alwaysshared
 130 Always treat new clients as shared (i.e. ignore client's shared flag).
 131
 132 .TP
 133 .B \-nevershared
 134 Never treat new clients as shared (i.e. ignore client's shared flag).
 135
 136 .TP
 137 .B \-dontdisconnect
 138 Don't disconnect existing clients when a new "non-shared" connection comes
 139 in. Instead the new connection is refused. New "shared" connections are still
 140 allowed in the normal way.
 141
 142 .TP
 143 .B \-localhost
 144 Only allow connections from the same machine. Useful if you use SSH and want to
 145 stop non-SSH connections from any other hosts. See the guide to using VNC with
 146 SSH on the web site.
 147
 148 .TP
 149 .B \-inetd
 150 This significantly changes Xvnc's behaviour so that it can be launched from
 151 inetd. Instead of listening for TCP connections it uses its standard input and
 152 standard output as a connection to the VNC viewer. See the information on the
 153 extras page on the web site for details.
 154
 155 .SH SEE ALSO
 156 .BR vncconnect (1),
 157 .BR vncpasswd (1),
 158 .BR vncserver (1),
 159 .BR vncviewer (1),
 160 .BR Xserver (1)
 161 .br
 162 http://www.realvnc.com
 163
 164 .SH AUTHOR
 165 Tristan Richardson, RealVNC Ltd.
 166
 167 VNC was originally developed by the RealVNC team while at Olivetti Research Ltd
 168 / AT&T Laboratories Cambridge.  It is now being maintained by RealVNC Ltd.  See
 169 http://www.realvnc.com for details.