blob: 11344bb5c746829c1d139369557cdb8fa14b32d3 [file] [log] [blame]
Peter Åstrand4eacc022009-02-27 10:12:14 +00001.TH X0VNCSERVER 1 "Dec 23, 2008" "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).
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000015.SH OPTIONS
16.B x0vncserver
17interprets the command line as a list of parameters with optional values.
18Running \fBx0vncserver -h\fP will show a list of all valid parameters with
Constantin Kaplinsky59740082008-01-08 10:42:22 +000019short descriptions. All parameters are optional, but normally you would have
Constantin Kaplinskycef45772008-01-07 14:52:51 +000020to use the \fBPasswordFile\fP parameter (see its description below).
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000021.PP
22There are several forms of specifying parameters in the command line (here we
23use `\fISomeParameter\fP' as an example parameter name):
24.TP
25.B -\fISomeParameter\fP
Constantin Kaplinsky59740082008-01-08 10:42:22 +000026Enable the parameter, turn the feature on. This form can be used with
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000027parameters that simply enable or disable some feature.
28.TP
29.B -\fISomeParameter\fP=0
30Disable the parameter, turn the feature off.
31.TP
32.B -\fISomeParameter\fP=\fIvalue\fP
Constantin Kaplinsky59740082008-01-08 10:42:22 +000033Assign the specified \fIvalue\fP to the parameter. The leading dash can be
34omitted, or it can be doubled if desired (like in GNU-style long options).
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000035.PP
36Parameter names are case-insensitive, their order in the command line can be
37arbitrary.
Constantin Kaplinskycef45772008-01-07 14:52:51 +000038.SH PARAMETERS
39.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000040.B display
Constantin Kaplinsky59740082008-01-08 10:42:22 +000041The X display name. If not specified, it defaults to the value of the
42DISPLAY environment variable.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000043.TP
44.B rfbport
Constantin Kaplinsky59740082008-01-08 10:42:22 +000045TCP port to listen for incoming VNC connections (RFB protocol). The default
46port is 5900.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000047.TP
48.B Log
49Specifies which log output should be directed to which target logger, and the
Constantin Kaplinsky59740082008-01-08 10:42:22 +000050level of output to log. Format is \fIlog\fP:\fItarget\fP:\fIlevel\fP.
51Default is \fB*:stderr:30\fP (log everything to stderr, set log level to 30).
52Log level should be a value between 0 and 100, higher levels produce more
53output.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000054.TP
55.B HostsFile
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +000056This parameter allows to specify a file name with IP access control rules.
57The file should include one rule per line, and the rule format is one of the
58following: +\fIaddress\fP/\fInetmask\fP (accept connections from the
59specified address group), -\fIaddress\fP/\fInetmask\fP (reject connections)
60or ?\fIaddress\fP/\fInetmask\fP (query the local user). The first rule
61matching the IP address determines the action to be performed. Rules that
62include only an action sign (+, - or ?) will match any IP address.
63\fINetmask\fP is optional and can be specified either in dotted format
64(e.g. /255.255.255.0), or as a single number of bits (e.g. /24). Default is
65to accept connections from any IP address.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000066.TP
67.B SecurityTypes
Constantin Kaplinsky59740082008-01-08 10:42:22 +000068Specify which security scheme to use for incoming connections. Valid values
69are \fBNone\fP and \fBVncAuth\fP. Default is \fBVncAuth\fP.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000070.TP
71.B PasswordFile
Constantin Kaplinsky59740082008-01-08 10:42:22 +000072Password file for VNC authentication. There is no default, you should
73specify the password file explicitly. Password file should be created with
74the \fBvncpasswd\fP(1) utility.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000075.TP
76.B Password
77Obfuscated binary encoding of the password which clients must supply to
Constantin Kaplinsky59740082008-01-08 10:42:22 +000078access the server. Using this parameter is insecure, use \fBPasswordFile\fP
79parameter instead.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000080.TP
81.B BlacklistThreshold
82The number of unauthenticated connection attempts allowed from any individual
Constantin Kaplinsky59740082008-01-08 10:42:22 +000083host before that host is black-listed. Default is 5.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000084.TP
85.B BlacklistTimeout
Constantin Kaplinsky59740082008-01-08 10:42:22 +000086The initial timeout applied when a host is first black-listed. The host
87cannot re-attempt a connection until the timeout expires. Default is 10.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000088.TP
89.B QueryConnect
Constantin Kaplinsky59740082008-01-08 10:42:22 +000090Prompt the local user to accept or reject incoming connections. Default is
91off.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000092.TP
93.B QueryConnectTimeout
94Number of seconds to show the Accept Connection dialog before rejecting the
Constantin Kaplinsky59740082008-01-08 10:42:22 +000095connection. Default is 10.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +000096.TP
97.B AlwaysShared
98Always treat incoming connections as shared, regardless of the
Constantin Kaplinsky59740082008-01-08 10:42:22 +000099client-specified setting. Default is off.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000100.TP
101.B NeverShared
102Never treat incoming connections as shared, regardless of the
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000103client-specified setting. Default is off.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000104.TP
105.B DisconnectClients
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000106Disconnect existing clients if an incoming connection is non-shared. If
107combined with \fBNeverShared\fP then new connections will be refused while
108there is a client active. Default is on.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000109.TP
110.B AcceptKeyEvents
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000111Accept key press and release events from clients. Default is on.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000112.TP
113.B AcceptPointerEvents
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000114Accept pointer events from clients. Default is on.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000115.TP
116.B RemapKeys
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000117Comma-separated list of incoming keysyms to remap. Mappings are expressed as
118two hex values, prefixed by \fB0x\fP, and separated by \fB->\fP (`dash' and
119`greater than' characters).
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000120.TP
121.B Protocol3.3
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000122Always use RFB protocol version 3.3 for backwards compatibility with
123badly-behaved clients. Default is off.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000124.TP
125.B Geometry
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000126This option specifies the screen area that will be shown to VNC clients. The
127format is
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000128.B \fIwidth\fPx\fIheight\fP+\fIxoffset\fP+\fIyoffset\fP
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000129, where `+' signs can be replaced with `\-' signs to specify offsets from the
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000130right and/or from the bottom of the screen. Offsets are optional, +0+0 is
131assumed by default (top left corner). If the argument is empty, full screen
132is shown to VNC clients (this is the default).
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000133.TP
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000134.B MaxProcessorUsage
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000135Maximum percentage of CPU time to be consumed when polling the
136screen. Default is 35.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000137.TP
138.B PollingCycle
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000139Milliseconds per one polling cycle. Actual interval may be dynamically
140adjusted to satisfy \fBMaxProcessorUsage\fP setting. Default is 30.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000141.TP
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000142.B VideoArea
143This option specifies the screen area that will be handled as video. The
144format is
145.B \fIwidth\fPx\fIheight\fP+\fIxoffset\fP+\fIyoffset\fP
146, where `+' signs can be replaced with `\-' signs to specify offsets from the
147right and/or from the bottom of the screen. Offsets are optional, +0+0 is
148assumed by default (top left corner). Video area is not checked for actual
149changes, it is assumed to be changing continuously and is sent in each screen
150update. Normally, video area is compressed with JPEG (if allowed by the
Peter Åstrand4eacc022009-02-27 10:12:14 +0000151client). Note that this setting can be overriden by TigerVNC clients
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000152supporting VideoRectangleSelection protocol extension. In other words,
153clients may choose video selection themselves, but if they do not, then the
154\fBVideoArea\fP parameter will take effect. If the argument is empty, no
155video area is set (this is the default).
156.TP
Constantin Kaplinsky3fed47c2008-12-23 07:21:02 +0000157.B VideoPriority
158Specify the priority of sending video updates. \fBx0vncserver\fP can be
159instructed to treat certain rectangular part of the screen as a video area
Constantin Kaplinskyf32f8852008-12-23 07:44:39 +0000160and handle it in a special way for improved performance (see documentation on
161the \fBVideoArea\fP parameter). \fBVideoPriority\fP value controls how often
Constantin Kaplinsky3fed47c2008-12-23 07:21:02 +0000162video area will be sent to clients as compared to the rest of the screen.
163The priority must be an integer between 0 and 8, and the default value is 2.
164
165\fBVideoPriority\fP set to 1 gives the same priority both to video and to
166other pixels. Higher values give more priority to video. For example, the
167value 5 specifies that the rate of sending video will be five times higher
168than the rate of updating the rest of the screen. If \fBVideoPriority\fP is
169set to 0, it gives equal priority to video and other updates (just like the
170value 1) and also disables special encoding for video data. In other words,
171\fBVideoPriority\fP video area will be sent as a part of other screen
172contents.
173.TP
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000174.B CompareFB
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000175Perform pixel comparison on framebuffer to reduce unnecessary updates.
176Default is on.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000177.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000178.B UseSHM
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000179Use MIT-SHM extension if available. Using that extension accelerates reading
180the screen. Default is on.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000181.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000182.B OverlayMode
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000183Use overlay mode in IRIX or Solaris (does not have effect in other systems).
184This enables system-specific access to complete full-color version of the
185screen (the default X visual often provides 256 colors). Also, in overlay
186mode, \fBx0vncserver\fP can show correct mouse cursor. Default is on.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000187.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000188.B UseHardwareJPEG
Constantin Kaplinskyb8363be2008-01-08 13:48:19 +0000189Use hardware-accelerated JPEG compressor for video if available.
Constantin Kaplinsky9c6b8562008-12-23 07:23:37 +0000190\fBx0vncserver\fP can be instructed to treat certain rectangular part of the
191screen as a video area and handle it in a special way for improved
192performance. If the client supports Tight encoding and JPEG compression,
193such video areas will be sent as JPEG-encoded rectangles. And if this option
194is on, compression will be hardware-accelerated (currently, supported only in
195SGI/IRIX equipped with appropriate hardware). Default is on.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000196.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000197.B ZlibLevel
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000198Zlib compression level for ZRLE encoding (it does not affect Tight encoding).
199Acceptable values are between 0 and 9. Default is to use the standard
200compression level provided by the \fBzlib\fP(3) compression library.
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000201.TP
202.B ImprovedHextile
203Use improved compression algorithm for Hextile encoding which achieves better
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000204compression ratios by the cost of using slightly more CPU time. Default is
205on.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000206.TP
207.B IdleTimeout
208The number of seconds after which an idle VNC connection will be dropped
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000209(zero means no timeout). Default is 0.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000210.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000211.B MaxDisconnectionTime
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000212Terminate when no client has been connected for \fIN\fP seconds. Default is
2130.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000214.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000215.B MaxConnectionTime
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000216Terminate when a client has been connected for \fIN\fP seconds. Default is
2170.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000218.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000219.B MaxIdleTime
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000220Terminate after \fIN\fP seconds of user inactivity. Default is 0.
Constantin Kaplinskycef45772008-01-07 14:52:51 +0000221.TP
Constantin Kaplinsky8d61d0d2008-01-07 16:10:37 +0000222.B ClientWaitTimeMillis
Constantin Kaplinsky59740082008-01-08 10:42:22 +0000223The number of milliseconds to wait for a client which is no longer
224responding. Default is 20000.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000225.SH SEE ALSO
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +0000226.BR Xvnc (1),
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000227.BR vncpasswd (1),
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000228.br
Peter Åstrand4eacc022009-02-27 10:12:14 +0000229http://www.tigervnc.org/
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000230.SH AUTHOR
Pierre Ossmane37a1442014-09-17 14:08:16 +0200231Constantin Kaplinsky and others.
232
233VNC was originally developed by the RealVNC team while at Olivetti
234Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
235implemented by Constantin Kaplinsky. Many other people have since
236participated in development, testing and support. This manual is part
237of the TigerVNC software suite.