1X0VNCSERVER(1) TigerVNC Manual X0VNCSERVER(1)
2
6 x0vncserver - TigerVNC Server for X displays
7
9 x0vncserver [options]
10 x0vncserver -version
11
13 x0vncserver is a TigerVNC Server which makes any X display remotely
14 accessible via VNC, TigerVNC or compatible viewers. Unlike Xvnc(1), it
15 does not create a virtual display. Instead, it just shares an existing
16 X server (typically, that one connected to the physical screen).
17 XDamage will be used if the existing X server supports it. Otherwise
19 x0vncserver will fall back to polling the screen for changes.
20
23 x0vncserver interprets the command line as a list of parameters with
24 optional values. Running x0vncserver -h will show a list of all valid
25 parameters with short descriptions. All parameters are optional, but
26 normally you would have to use the PasswordFile parameter (see its
27 description below).
28 There are several forms of specifying parameters in the command line
30 (here we use `SomeParameter' as an example parameter name):
31 -SomeParameter
34 Enable the parameter, turn the feature on. This form can be
35 used with parameters that simply enable or disable some feature.
36 -SomeParameter=0
38 Disable the parameter, turn the feature off.
39 -SomeParameter=value
41 Assign the specified value to the parameter. The leading dash
42 can be omitted, or it can be doubled if desired (like in GNU-
43 style long options).
44 Parameter names are case-insensitive, their order in the command line
46 can be arbitrary.
47
50 display
51 The X display name. If not specified, it defaults to the value
52 of the DISPLAY environment variable.
53 rfbport
55 TCP port to listen for incoming VNC connections (RFB protocol).
56 The default port is 5900.
57 Log Specifies which log output should be directed to which target
59 logger, and the level of output to log. Format is log:tar‐
60 get:level. Default is *:stderr:30 (log everything to stderr,
61 set log level to 30). Log level should be a value between 0 and
62 100, higher levels produce more output.
63 HostsFile
65 This parameter allows to specify a file name with IP access con‐
66 trol rules. The file should include one rule per line, and the
67 rule format is one of the following: +address/prefix (accept
68 connections from the specified address group), -address/prefix
69 (reject connections) or ?address/prefix (query the local user).
70 The first rule matching the IP address determines the action to
71 be performed. Rules that include only an action sign (+, - or
72 ?) will match any IP address. Prefix is optional and is speci‐
73 fied as a number of bits (e.g. /24). Default is to accept con‐
74 nections from any IP address.
75 SecurityTypes
77 Specify which security scheme to use for incoming connections.
78 Valid values are a comma separated list of None, VncAuth, Plain,
79 TLSNone, TLSVnc, TLSPlain, X509None, X509Vnc and X509Plain.
80 Default is VncAuth,TLSVnc.
81 rfbauth, PasswordFile
83 Password file for VNC authentication. There is no default, you
84 should specify the password file explicitly. Password file
85 should be created with the vncpasswd(1) utility.
86 Password
88 Obfuscated binary encoding of the password which clients must
89 supply to access the server. Using this parameter is insecure,
90 use PasswordFile parameter instead.
91 PlainUsers
93 A comma separated list of user names that are allowed to authen‐
94 ticate via any of the "Plain" security types (Plain, TLSPlain,
95 etc.). Specify * to allow any user to authenticate using this
96 security type. Default is to deny all users.
97 pam_service, PAMService
99 PAM service name to use when authentication users using any of
100 the "Plain" security types. Default is vnc.
101 X509Cert
103 Path to a X509 certificate in PEM format to be used for all X509
104 based security types (X509None, X509Vnc, etc.).
105 X509Key
107 Private key counter part to the certificate given in X509Cert.
108 Must also be in PEM format.
109 BlacklistThreshold
111 The number of unauthenticated connection attempts allowed from
112 any individual host before that host is black-listed. Default
113 is 5.
114 BlacklistTimeout
116 The initial timeout applied when a host is first black-listed.
117 The host cannot re-attempt a connection until the timeout
118 expires. Default is 10.
119 QueryConnect
121 Prompt the local user to accept or reject incoming connections.
122 Default is off.
123 QueryConnectTimeout
125 Number of seconds to show the Accept Connection dialog before
126 rejecting the connection. Default is 10.
127 AlwaysShared
129 Always treat incoming connections as shared, regardless of the
130 client-specified setting. Default is off.
131 NeverShared
133 Never treat incoming connections as shared, regardless of the
134 client-specified setting. Default is off.
135 DisconnectClients
137 Disconnect existing clients if an incoming connection is non-
138 shared. If combined with NeverShared then new connections will
139 be refused while there is a client active. Default is on.
140 AcceptKeyEvents
142 Accept key press and release events from clients. Default is
143 on.
144 AcceptPointerEvents
146 Accept pointer events from clients. Default is on.
147 RemapKeys
149 Comma-separated list of incoming keysyms to remap. Mappings are
150 expressed as two hex values, prefixed by 0x, and separated by ->
151 (`dash' and `greater than' characters).
152 Protocol3.3
154 Always use RFB protocol version 3.3 for backwards compatibility
155 with badly-behaved clients. Default is off.
156 Geometry
158 This option specifies the screen area that will be shown to VNC
159 clients. The format is widthxheight+xoffset+yoffset , where `+'
160 signs can be replaced with `-' signs to specify offsets from the
161 right and/or from the bottom of the screen. Offsets are
162 optional, +0+0 is assumed by default (top left corner). If the
163 argument is empty, full screen is shown to VNC clients (this is
164 the default).
165 MaxProcessorUsage
167 Maximum percentage of CPU time to be consumed when polling the
168 screen. Default is 35.
169 PollingCycle
171 Milliseconds per one polling cycle. Actual interval may be
172 dynamically adjusted to satisfy MaxProcessorUsage setting.
173 Default is 30.
174 DeferUpdate
176 x0vncserver uses a "deferred update" mechanism which enhances
177 performance in many cases. After any change to the framebuffer,
178 x0vncserver waits for this number of milliseconds (default 1)
179 before sending an update to any waiting clients. This means that
180 more changes tend to get coalesced together in a single update.
181 Setting it to 0 results in the same behaviour as earlier ver‐
182 sions of x0vncserver, where the first change to the framebuffer
183 causes an immediate update to any waiting clients.
184 AlwaysSetDeferUpdateTimer
186 Keep delaying sending the screen update to the client(s) each
187 time the screen is updated. Otherwise the delay is from the
188 first update. Default is off.
189 CompareFB
191 Perform pixel comparison on framebuffer to reduce unnecessary
192 updates. Can be either 0 (off), 1 (always) or 2 (auto). Default
193 is 2.
194 UseSHM Use MIT-SHM extension if available. Using that extension accel‐
196 erates reading the screen. Default is on.
197 OverlayMode
199 Use overlay mode in IRIX or Solaris (does not have effect in
200 other systems). This enables system-specific access to complete
201 full-color version of the screen (the default X visual often
202 provides 256 colors). Also, in overlay mode, x0vncserver can
203 show correct mouse cursor. Default is on.
204 ZlibLevel
206 Zlib compression level for ZRLE encoding (it does not affect
207 Tight encoding). Acceptable values are between 0 and 9.
208 Default is to use the standard compression level provided by the
209 zlib(3) compression library.
210 ImprovedHextile
212 Use improved compression algorithm for Hextile encoding which
213 achieves better compression ratios by the cost of using slightly
214 more CPU time. Default is on.
215 IdleTimeout
217 The number of seconds after which an idle VNC connection will be
218 dropped (zero means no timeout). Default is 0.
219 MaxDisconnectionTime
221 Terminate when no client has been connected for N seconds.
222 Default is 0.
223 MaxConnectionTime
225 Terminate when a client has been connected for N seconds.
226 Default is 0.
227 MaxIdleTime
229 Terminate after N seconds of user inactivity. Default is 0.
230 ClientWaitTimeMillis
232 The number of milliseconds to wait for a client which is no
233 longer responding. Default is 20000.
234 AcceptCutText
236 SendCutText
237 MaxCutText
238 Currently unused.
239
242 Xvnc(1), vncpasswd(1),
243 http://www.tigervnc.org/
244
247 Constantin Kaplinsky and others.
248 VNC was originally developed by the RealVNC team while at Olivetti
250 Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
251 implemented by Constantin Kaplinsky. Many other people have since par‐
252 ticipated in development, testing and support. This manual is part of
253 the TigerVNC software suite.
254TigerVNC X0VNCSERVER(1)