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
19 x0vncserver interprets the command line as a list of parameters with
20 optional values. Running x0vncserver -h will show a list of all valid
21 parameters with short descriptions. All parameters are optional, but
22 normally you would have to use the PasswordFile parameter (see its
23 description below).
24 There are several forms of specifying parameters in the command line
26 (here we use `SomeParameter' as an example parameter name):
27 -SomeParameter
29 Enable the parameter, turn the feature on. This form can be
30 used with parameters that simply enable or disable some feature.
31 -SomeParameter=0
33 Disable the parameter, turn the feature off.
34 -SomeParameter=value
36 Assign the specified value to the parameter. The leading dash
37 can be omitted, or it can be doubled if desired (like in GNU-
38 style long options).
39 Parameter names are case-insensitive, their order in the command line
41 can be arbitrary.
42
44 display
45 The X display name. If not specified, it defaults to the value
46 of the DISPLAY environment variable.
47 rfbport
49 TCP port to listen for incoming VNC connections (RFB protocol).
50 The default port is 5900.
51 Log Specifies which log output should be directed to which target
53 logger, and the level of output to log. Format is log:tar‐
54 get:level. Default is *:stderr:30 (log everything to stderr,
55 set log level to 30). Log level should be a value between 0 and
56 100, higher levels produce more output.
57 HostsFile
59 This parameter allows to specify a file name with IP access con‐
60 trol rules. The file should include one rule per line, and the
61 rule format is one of the following: +address/netmask (accept
62 connections from the specified address group), -address/netmask
63 (reject connections) or ?address/netmask (query the local user).
64 The first rule matching the IP address determines the action to
65 be performed. Rules that include only an action sign (+, - or
66 ?) will match any IP address. Netmask is optional and can be
67 specified either in dotted format (e.g. /255.255.255.0), or as a
68 single number of bits (e.g. /24). Default is to accept connec‐
69 tions from any IP address.
70 SecurityTypes
72 Specify which security scheme to use for incoming connections.
73 Valid values are None and VncAuth. Default is VncAuth.
74 PasswordFile
76 Password file for VNC authentication. There is no default, you
77 should specify the password file explicitly. Password file
78 should be created with the vncpasswd(1) utility.
79 Password
81 Obfuscated binary encoding of the password which clients must
82 supply to access the server. Using this parameter is insecure,
83 use PasswordFile parameter instead.
84 BlacklistThreshold
86 The number of unauthenticated connection attempts allowed from
87 any individual host before that host is black-listed. Default
88 is 5.
89 BlacklistTimeout
91 The initial timeout applied when a host is first black-listed.
92 The host cannot re-attempt a connection until the timeout
93 expires. Default is 10.
94 QueryConnect
96 Prompt the local user to accept or reject incoming connections.
97 Default is off.
98 QueryConnectTimeout
100 Number of seconds to show the Accept Connection dialog before
101 rejecting the connection. Default is 10.
102 AlwaysShared
104 Always treat incoming connections as shared, regardless of the
105 client-specified setting. Default is off.
106 NeverShared
108 Never treat incoming connections as shared, regardless of the
109 client-specified setting. Default is off.
110 DisconnectClients
112 Disconnect existing clients if an incoming connection is non-
113 shared. If combined with NeverShared then new connections will
114 be refused while there is a client active. Default is on.
115 AcceptKeyEvents
117 Accept key press and release events from clients. Default is
118 on.
119 AcceptPointerEvents
121 Accept pointer events from clients. Default is on.
122 RemapKeys
124 Comma-separated list of incoming keysyms to remap. Mappings are
125 expressed as two hex values, prefixed by 0x, and separated by ->
126 (`dash' and `greater than' characters).
127 Protocol3.3
129 Always use RFB protocol version 3.3 for backwards compatibility
130 with badly-behaved clients. Default is off.
131 Geometry
133 This option specifies the screen area that will be shown to VNC
134 clients. The format is widthxheight+xoffset+yoffset , where `+'
135 signs can be replaced with `-' signs to specify offsets from the
136 right and/or from the bottom of the screen. Offsets are
137 optional, +0+0 is assumed by default (top left corner). If the
138 argument is empty, full screen is shown to VNC clients (this is
139 the default).
140 MaxProcessorUsage
142 Maximum percentage of CPU time to be consumed when polling the
143 screen. Default is 35.
144 PollingCycle
146 Milliseconds per one polling cycle. Actual interval may be
147 dynamically adjusted to satisfy MaxProcessorUsage setting.
148 Default is 30.
149 VideoArea
151 This option specifies the screen area that will be handled as
152 video. The format is widthxheight+xoffset+yoffset , where `+'
153 signs can be replaced with `-' signs to specify offsets from the
154 right and/or from the bottom of the screen. Offsets are
155 optional, +0+0 is assumed by default (top left corner). Video
156 area is not checked for actual changes, it is assumed to be
157 changing continuously and is sent in each screen update. Nor‐
158 mally, video area is compressed with JPEG (if allowed by the
159 client). Note that this setting can be overriden by TigerVNC
160 clients supporting VideoRectangleSelection protocol extension.
161 In other words, clients may choose video selection themselves,
162 but if they do not, then the VideoArea parameter will take
163 effect. If the argument is empty, no video area is set (this is
164 the default).
165 VideoPriority
167 Specify the priority of sending video updates. x0vncserver can
168 be instructed to treat certain rectangular part of the screen as
169 a video area and handle it in a special way for improved perfor‐
170 mance (see documentation on the VideoArea parameter). VideoPri‐
171 ority value controls how often video area will be sent to
172 clients as compared to the rest of the screen. The priority
173 must be an integer between 0 and 8, and the default value is 2.
174 VideoPriority set to 1 gives the same priority both to video and
176 to other pixels. Higher values give more priority to video.
177 For example, the value 5 specifies that the rate of sending
178 video will be five times higher than the rate of updating the
179 rest of the screen. If VideoPriority is set to 0, it gives
180 equal priority to video and other updates (just like the value
181 1) and also disables special encoding for video data. In other
182 words, VideoPriority video area will be sent as a part of other
183 screen contents.
184 CompareFB
186 Perform pixel comparison on framebuffer to reduce unnecessary
187 updates. Default is on.
188 UseSHM Use MIT-SHM extension if available. Using that extension accel‐
190 erates reading the screen. Default is on.
191 OverlayMode
193 Use overlay mode in IRIX or Solaris (does not have effect in
194 other systems). This enables system-specific access to complete
195 full-color version of the screen (the default X visual often
196 provides 256 colors). Also, in overlay mode, x0vncserver can
197 show correct mouse cursor. Default is on.
198 UseHardwareJPEG
200 Use hardware-accelerated JPEG compressor for video if available.
201 x0vncserver can be instructed to treat certain rectangular part
202 of the screen as a video area and handle it in a special way for
203 improved performance. If the client supports Tight encoding and
204 JPEG compression, such video areas will be sent as JPEG-encoded
205 rectangles. And if this option is on, compression will be hard‐
206 ware-accelerated (currently, supported only in SGI/IRIX equipped
207 with appropriate hardware). Default is on.
208 ZlibLevel
210 Zlib compression level for ZRLE encoding (it does not affect
211 Tight encoding). Acceptable values are between 0 and 9.
212 Default is to use the standard compression level provided by the
213 zlib(3) compression library.
214 ImprovedHextile
216 Use improved compression algorithm for Hextile encoding which
217 achieves better compression ratios by the cost of using slightly
218 more CPU time. Default is on.
219 IdleTimeout
221 The number of seconds after which an idle VNC connection will be
222 dropped (zero means no timeout). Default is 0.
223 MaxDisconnectionTime
225 Terminate when no client has been connected for N seconds.
226 Default is 0.
227 MaxConnectionTime
229 Terminate when a client has been connected for N seconds.
230 Default is 0.
231 MaxIdleTime
233 Terminate after N seconds of user inactivity. Default is 0.
234 ClientWaitTimeMillis
236 The number of milliseconds to wait for a client which is no
237 longer responding. Default is 20000.
238
240 Xvnc(1), vncpasswd(1),
241 http://www.tigervnc.org/
242
244 This manual page was written by Constantin Kaplinsky.
245TigerVNC Dec 23, 2008 X0VNCSERVER(1)