blob: 50bb9fb7f4f1e77d3f57bf12ba78c24229754544 [file] [log] [blame]
Pierre Ossmanf256a1a2014-09-17 14:09:58 +02001.TH X0VNCSERVER 1 "" "TigerVNC" "TigerVNC Manual"
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +00002.SH NAME
Peter Åstrand4eacc022009-02-27 10:12:14 +00003x0vncserver \- TigerVNC Server for X displays
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +00004.SH SYNOPSIS
5.B x0vncserver
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +00006.RI [ options ]
Constantin Kaplinsky2039d7b2008-06-04 10:43:10 +00007.br
8.B x0vncserver -version
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +00009.SH DESCRIPTION
10.B x0vncserver
Peter Åstrand4eacc022009-02-27 10:12:14 +000011is a TigerVNC Server which makes any X display remotely accessible via VNC,
12TigerVNC or compatible viewers. Unlike \fBXvnc\fP(1), it does not create a
Constantin Kaplinsky59740082008-01-08 10:42:22 +000013virtual display. Instead, it just shares an existing X server (typically,
14that one connected to the physical screen).
Pierre Ossmande0f8322014-09-17 15:43:14 +020015
16XDamage will be used if the existing X server supports it. Otherwise
17.B x0vncserver
18will fall back to polling the screen for changes.
Pierre Ossman23f67c32014-09-17 16:28:56 +020019
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000020.SH OPTIONS
21.B x0vncserver
22interprets the command line as a list of parameters with optional values.
23Running \fBx0vncserver -h\fP will show a list of all valid parameters with
Constantin Kaplinsky59740082008-01-08 10:42:22 +000024short descriptions. All parameters are optional, but normally you would have
Constantin Kaplinskycef45772008-01-07 14:52:51 +000025to use the \fBPasswordFile\fP parameter (see its description below).
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000026.PP
27There are several forms of specifying parameters in the command line (here we
28use `\fISomeParameter\fP' as an example parameter name):
Pierre Ossman23f67c32014-09-17 16:28:56 +020029
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000030.TP
31.B -\fISomeParameter\fP
Constantin Kaplinsky59740082008-01-08 10:42:22 +000032Enable the parameter, turn the feature on. This form can be used with
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000033parameters that simply enable or disable some feature.
Pierre Ossman23f67c32014-09-17 16:28:56 +020034.
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000035.TP
36.B -\fISomeParameter\fP=0
37Disable the parameter, turn the feature off.
Pierre Ossman23f67c32014-09-17 16:28:56 +020038.
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000039.TP
40.B -\fISomeParameter\fP=\fIvalue\fP
Constantin Kaplinsky59740082008-01-08 10:42:22 +000041Assign the specified \fIvalue\fP to the parameter. The leading dash can be
42omitted, or it can be doubled if desired (like in GNU-style long options).
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000043.PP
44Parameter names are case-insensitive, their order in the command line can be
45arbitrary.
Pierre Ossman23f67c32014-09-17 16:28:56 +020046
Constantin Kaplinskycef45772008-01-07 14:52:51 +000047.SH PARAMETERS
Pierre Ossman23f67c32014-09-17 16:28:56 +020048
Constantin Kaplinskycef45772008-01-07 14:52:51 +000049.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000050.B display
Constantin Kaplinsky59740082008-01-08 10:42:22 +000051The X display name. If not specified, it defaults to the value of the
52DISPLAY environment variable.
Pierre Ossman23f67c32014-09-17 16:28:56 +020053.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000054.TP
55.B rfbport
Constantin Kaplinsky59740082008-01-08 10:42:22 +000056TCP port to listen for incoming VNC connections (RFB protocol). The default
57port is 5900.
Pierre Ossman23f67c32014-09-17 16:28:56 +020058.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000059.TP
60.B Log
61Specifies which log output should be directed to which target logger, and the
Constantin Kaplinsky59740082008-01-08 10:42:22 +000062level of output to log. Format is \fIlog\fP:\fItarget\fP:\fIlevel\fP.
63Default is \fB*:stderr:30\fP (log everything to stderr, set log level to 30).
64Log level should be a value between 0 and 100, higher levels produce more
65output.
Pierre Ossman23f67c32014-09-17 16:28:56 +020066.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000067.TP
68.B HostsFile
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +000069This parameter allows to specify a file name with IP access control rules.
70The file should include one rule per line, and the rule format is one of the
71following: +\fIaddress\fP/\fInetmask\fP (accept connections from the
72specified address group), -\fIaddress\fP/\fInetmask\fP (reject connections)
73or ?\fIaddress\fP/\fInetmask\fP (query the local user). The first rule
74matching the IP address determines the action to be performed. Rules that
75include only an action sign (+, - or ?) will match any IP address.
76\fINetmask\fP is optional and can be specified either in dotted format
77(e.g. /255.255.255.0), or as a single number of bits (e.g. /24). Default is
78to accept connections from any IP address.
Pierre Ossman23f67c32014-09-17 16:28:56 +020079.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000080.TP
81.B SecurityTypes
Constantin Kaplinsky59740082008-01-08 10:42:22 +000082Specify which security scheme to use for incoming connections. Valid values
Pierre Ossmande0f8322014-09-17 15:43:14 +020083are a comma separated list of \fBNone\fP, \fBVncAuth\fP, \fBPlain\fP,
84\fBTLSNone\fP, \fBTLSVnc\fP, \fBTLSPlain\fP, \fBX509None\fP, \fBX509Vnc\fP
85and \fBX509Plain\fP. Default is \fBVncAuth,TLSVnc\fP.
Pierre Ossman23f67c32014-09-17 16:28:56 +020086.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000087.TP
Pierre Ossmande0f8322014-09-17 15:43:14 +020088.B rfbauth, PasswordFile
Constantin Kaplinsky59740082008-01-08 10:42:22 +000089Password file for VNC authentication. There is no default, you should
90specify the password file explicitly. Password file should be created with
91the \fBvncpasswd\fP(1) utility.
Pierre Ossman23f67c32014-09-17 16:28:56 +020092.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000093.TP
94.B Password
95Obfuscated binary encoding of the password which clients must supply to
Constantin Kaplinsky59740082008-01-08 10:42:22 +000096access the server. Using this parameter is insecure, use \fBPasswordFile\fP
97parameter instead.
Pierre Ossman23f67c32014-09-17 16:28:56 +020098.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000099.TP
Pierre Ossmande0f8322014-09-17 15:43:14 +0200100.B PlainUsers
101A comma separated list of user names that are allowed to authenticate via
102any of the "Plain" security types (Plain, TLSPlain, etc.). Specify \fB*\fP
103to allow any user to authenticate using this security type. Default is to
104deny all users.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200105.
Pierre Ossmande0f8322014-09-17 15:43:14 +0200106.TP
107.B pam_service
108PAM service name to use when authentication users using any of the "Plain"
109security types. Default is \fBvnc\fP.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200110.
Pierre Ossmande0f8322014-09-17 15:43:14 +0200111.TP
112.B x509cert
113Path to a X509 certificate in PEM format to be used for all X509 based
114security types (X509None, X509Vnc, etc.).
Pierre Ossman23f67c32014-09-17 16:28:56 +0200115.
Pierre Ossmande0f8322014-09-17 15:43:14 +0200116.TP
117.B x509key
118Private key counter part to the certificate given in \fBx509cert\fP. Must
119also be in PEM format.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200120.
Pierre Ossmande0f8322014-09-17 15:43:14 +0200121.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000122.B BlacklistThreshold
123The number of unauthenticated connection attempts allowed from any individual
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000124host before that host is black-listed. Default is 5.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200125.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000126.TP
127.B BlacklistTimeout
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000128The initial timeout applied when a host is first black-listed. The host
129cannot re-attempt a connection until the timeout expires. Default is 10.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200130.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000131.TP
132.B QueryConnect
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000133Prompt the local user to accept or reject incoming connections. Default is
134off.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200135.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000136.TP
137.B QueryConnectTimeout
138Number of seconds to show the Accept Connection dialog before rejecting the
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000139connection. Default is 10.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200140.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000141.TP
142.B AlwaysShared
143Always treat incoming connections as shared, regardless of the
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000144client-specified setting. Default is off.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200145.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000146.TP
147.B NeverShared
148Never treat incoming connections as shared, regardless of the
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000149client-specified setting. Default is off.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200150.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000151.TP
152.B DisconnectClients
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000153Disconnect existing clients if an incoming connection is non-shared. If
154combined with \fBNeverShared\fP then new connections will be refused while
155there is a client active. Default is on.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200156.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000157.TP
158.B AcceptKeyEvents
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000159Accept key press and release events from clients. Default is on.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200160.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000161.TP
162.B AcceptPointerEvents
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000163Accept pointer events from clients. Default is on.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200164.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000165.TP
166.B RemapKeys
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000167Comma-separated list of incoming keysyms to remap. Mappings are expressed as
168two hex values, prefixed by \fB0x\fP, and separated by \fB->\fP (`dash' and
169`greater than' characters).
Pierre Ossman23f67c32014-09-17 16:28:56 +0200170.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000171.TP
172.B Protocol3.3
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000173Always use RFB protocol version 3.3 for backwards compatibility with
174badly-behaved clients. Default is off.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200175.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000176.TP
177.B Geometry
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000178This option specifies the screen area that will be shown to VNC clients. The
179format is
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000180.B \fIwidth\fPx\fIheight\fP+\fIxoffset\fP+\fIyoffset\fP
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000181, where `+' signs can be replaced with `\-' signs to specify offsets from the
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000182right and/or from the bottom of the screen. Offsets are optional, +0+0 is
183assumed by default (top left corner). If the argument is empty, full screen
184is shown to VNC clients (this is the default).
Pierre Ossman23f67c32014-09-17 16:28:56 +0200185.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000186.TP
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000187.B MaxProcessorUsage
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000188Maximum percentage of CPU time to be consumed when polling the
189screen. Default is 35.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200190.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000191.TP
192.B PollingCycle
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000193Milliseconds per one polling cycle. Actual interval may be dynamically
194adjusted to satisfy \fBMaxProcessorUsage\fP setting. Default is 30.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200195.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000196.TP
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000197.B VideoArea
198This option specifies the screen area that will be handled as video. The
199format is
200.B \fIwidth\fPx\fIheight\fP+\fIxoffset\fP+\fIyoffset\fP
201, where `+' signs can be replaced with `\-' signs to specify offsets from the
202right and/or from the bottom of the screen. Offsets are optional, +0+0 is
203assumed by default (top left corner). Video area is not checked for actual
204changes, it is assumed to be changing continuously and is sent in each screen
205update. Normally, video area is compressed with JPEG (if allowed by the
Peter Åstrand4eacc022009-02-27 10:12:14 +0000206client). Note that this setting can be overriden by TigerVNC clients
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000207supporting VideoRectangleSelection protocol extension. In other words,
208clients may choose video selection themselves, but if they do not, then the
209\fBVideoArea\fP parameter will take effect. If the argument is empty, no
210video area is set (this is the default).
Pierre Ossman23f67c32014-09-17 16:28:56 +0200211.
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000212.TP
Pierre Ossmande0f8322014-09-17 15:43:14 +0200213.B DeferUpdate
214x0vncserver uses a "deferred update" mechanism which enhances performance in
215many cases. After any change to the framebuffer, x0vncserver waits for this
216number of milliseconds (default 1) before sending an update to any waiting
217clients. This means that more changes tend to get coalesced together in a
218single update. Setting it to 0 results in the same behaviour as earlier
219versions of x0vncserver, where the first change to the framebuffer causes an
220immediate update to any waiting clients.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200221.
Pierre Ossmande0f8322014-09-17 15:43:14 +0200222.TP
223.B AlwaysSetDeferUpdateTimer
224Keep delaying sending the screen update to the client(s) each time the
225screen is updated. Otherwise the delay is from the first update. Default
226is off.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200227.
Constantin Kaplinsky3fed47c2008-12-23 07:21:02 +0000228.TP
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000229.B CompareFB
Pierre Ossmande0f8322014-09-17 15:43:14 +0200230Perform pixel comparison on framebuffer to reduce unnecessary updates. Can
231be either \fB0\fP (off), \fB1\fP (always) or \fB2\fP (auto). Default is
232\fB2\fP.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200233.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000234.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000235.B UseSHM
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000236Use MIT-SHM extension if available. Using that extension accelerates reading
237the screen. Default is on.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200238.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000239.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000240.B OverlayMode
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000241Use overlay mode in IRIX or Solaris (does not have effect in other systems).
242This enables system-specific access to complete full-color version of the
243screen (the default X visual often provides 256 colors). Also, in overlay
244mode, \fBx0vncserver\fP can show correct mouse cursor. Default is on.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200245.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000246.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000247.B ZlibLevel
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000248Zlib compression level for ZRLE encoding (it does not affect Tight encoding).
249Acceptable values are between 0 and 9. Default is to use the standard
250compression level provided by the \fBzlib\fP(3) compression library.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200251.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000252.TP
253.B ImprovedHextile
254Use improved compression algorithm for Hextile encoding which achieves better
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000255compression ratios by the cost of using slightly more CPU time. Default is
256on.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200257.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000258.TP
259.B IdleTimeout
260The number of seconds after which an idle VNC connection will be dropped
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000261(zero means no timeout). Default is 0.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200262.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000263.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000264.B MaxDisconnectionTime
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000265Terminate when no client has been connected for \fIN\fP seconds. Default is
2660.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200267.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000268.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000269.B MaxConnectionTime
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000270Terminate when a client has been connected for \fIN\fP seconds. Default is
2710.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200272.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000273.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000274.B MaxIdleTime
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000275Terminate after \fIN\fP seconds of user inactivity. Default is 0.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200276.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000277.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000278.B ClientWaitTimeMillis
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000279The number of milliseconds to wait for a client which is no longer
280responding. Default is 20000.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200281.
Pierre Ossmande0f8322014-09-17 15:43:14 +0200282.TP
283.B AcceptCutText
284.TQ
285.B SendCutText
286.TQ
287.B MaxCutText
288Currently unused.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200289
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000290.SH SEE ALSO
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +0000291.BR Xvnc (1),
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000292.BR vncpasswd (1),
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000293.br
Peter Åstrand4eacc022009-02-27 10:12:14 +0000294http://www.tigervnc.org/
Pierre Ossman23f67c32014-09-17 16:28:56 +0200295
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000296.SH AUTHOR
Pierre Ossmane37a1442014-09-17 14:08:16 +0200297Constantin Kaplinsky and others.
298
299VNC was originally developed by the RealVNC team while at Olivetti
300Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
301implemented by Constantin Kaplinsky. Many other people have since
302participated in development, testing and support. This manual is part
303of the TigerVNC software suite.