blob: 6ea00ef6bac196578f24624ddcc966fde348f797 [file] [log] [blame]
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +00001.TH X0VNCSERVER 1 "January 7, 2008" "TightVNC" "TightVNC Manual"
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +00002.SH NAME
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +00003x0vncserver \- TightVNC Server for real 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 Kaplinskyb30ae7f2006-05-25 05:04:46 +00007.SH DESCRIPTION
8.B x0vncserver
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +00009is a TightVNC Server which makes any X display remotely accessible via VNC,
10TightVNC or compatible viewers. Unlike Xvnc, it does not create a virtual
11display. Instead, it just shares an existing X server (typically, that one
12connected to the physical screen).
13.SH OPTIONS
14.B x0vncserver
15interprets the command line as a list of parameters with optional values.
16Running \fBx0vncserver -h\fP will show a list of all valid parameters with
17short descriptions. All parameters are optional, but normally you would have
Constantin Kaplinskycef45772008-01-07 14:52:51 +000018to use the \fBPasswordFile\fP parameter (see its description below).
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +000019.PP
20There are several forms of specifying parameters in the command line (here we
21use `\fISomeParameter\fP' as an example parameter name):
22.TP
23.B -\fISomeParameter\fP
24Enable the parameter, turn the feature on. This form can be used with
25parameters that simply enable or disable some feature.
26.TP
27.B -\fISomeParameter\fP=0
28Disable the parameter, turn the feature off.
29.TP
30.B -\fISomeParameter\fP=\fIvalue\fP
31Assign the specified \fIvalue\fP to the parameter. The leading dash can be
32omitted, or it can be doubled if desired (like in GNU-style long
33options). The equality sign is optional so it can be replaced by spaces.
34.PP
35Parameter names are case-insensitive, their order in the command line can be
36arbitrary.
Constantin Kaplinskycef45772008-01-07 14:52:51 +000037.SH PARAMETERS
38.TP
39.B VideoPriority
40Priority of sending updates for video area (0..8) (default=2)
41.TP
42.B Geometry
43Screen area shown to VNC clients. Format is
44<width>x<height>+<offset_x>+<offset_y>, more information in man X, section
45GEOMETRY SPECIFICATIONS. If the argument is empty, full screen is shown to
46VNC clients. (default=)
47.TP
48.B HostsFile
49File with IP access control rules (default=)
50.TP
51.B QueryConnectTimeout
52Number of seconds to show the Accept Connection dialog before rejecting the
53connection (default=10)
54.TP
55.B rfbport
56TCP port to listen for RFB protocol (default=5900)
57.TP
58.B display
59The X display (default=)
60.TP
61.B OverlayMode
62Use overlay mode under IRIX or Solaris (default=1)
63.TP
64.B UseSHM
65Use MIT-SHM extension if available (default=1)
66.TP
67.B MaxProcessorUsage
68Maximum percentage of CPU time to be consumed (default=35)
69.TP
70.B PollingCycle
71Milliseconds per one polling cycle; actual interval may be dynamically
72adjusted to satisfy MaxProcessorUsage setting (default=30)
73.TP
74.B Log
75Specifies which log output should be directed to which target logger, and the
76level of output to log. Format is <log>:<target>:<level>[, ...]. (default=)
77.TP
78.B BlacklistTimeout
79The initial timeout applied when a host is first black-listed. The host
80cannot re-attempt a connection until the timeout expires. (default=10)
81.TP
82.B BlacklistThreshold
83The number of unauthenticated connection attempts allowed from any individual
84host before that host is black-listed (default=5)
85.TP
86.B ImprovedHextile
87Use improved compression algorithm for Hextile encoding which achieves better
88compression ratios by the cost of using more CPU time (default=1)
89.TP
90.B RemapKeys
91Comma-separated list of incoming keysyms to remap. Mappings are expressed as
92two hex values, prefixed by 0x, and separated by -> (default=)
93.TP
94.B QueryConnect
95Prompt the local user to accept or reject incoming connections. (default=0)
96.TP
97.B SendCutText
98Send clipboard changes to clients. (default=1)
99.TP
100.B AcceptCutText
101Accept clipboard updates from clients. (default=1)
102.TP
103.B AcceptPointerEvents
104Accept pointer press and release events from clients. (default=1)
105.TP
106.B AcceptKeyEvents
107Accept key press and release events from clients. (default=1)
108.TP
109.B DisconnectClients
110Disconnect existing clients if an incoming connection is non-shared. If
111combined with NeverShared then new connections will be refused while there is
112a client active (default=1)
113.TP
114.B NeverShared
115Never treat incoming connections as shared, regardless of the
116client-specified setting (default=0)
117.TP
118.B AlwaysShared
119Always treat incoming connections as shared, regardless of the
120client-specified setting (default=0)
121.TP
122.B Protocol3.3
123Always use protocol version 3.3 for backwards compatibility with
124badly-behaved clients (default=0)
125.TP
126.B CompareFB
127Perform pixel comparison on framebuffer to reduce unnecessary updates
128(default=1)
129.TP
130.B ClientWaitTimeMillis
131The number of milliseconds to wait for a client which is no longer responding
132(default=20000)
133.TP
134.B MaxIdleTime
135Terminate after s seconds of user inactivity (default=0)
136.TP
137.B MaxConnectionTime
138Terminate when a client has been connected for s seconds (default=0)
139.TP
140.B MaxDisconnectionTime
141Terminate when no client has been connected for s seconds (default=0)
142.TP
143.B IdleTimeout
144The number of seconds after which an idle VNC connection will be dropped
145(zero means no timeout) (default=0)
146.TP
147.B Password
148Obfuscated binary encoding of the password which clients must supply to
149access the server (default=)
150.TP
151.B PasswordFile
152Password file for VNC authentication (default=)
153.TP
154.B ReverseSecurityTypes
155Specify encryption scheme to use for reverse connections (None)
156(default=None)
157.TP
158.B SecurityTypes
159Specify which security scheme to use for incoming connections (None, VncAuth)
160(default=VncAuth)
161.TP
162.B ZlibLevel
163Zlib compression level (default=-1)
164.TP
165.B UseHardwareJPEG
166Use hardware-accelerated JPEG compressor for video if available (default=1)
167.TP
168.B MaxCutText
169Maximum permitted length of an incoming clipboard update (default=262144)
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000170.SH SEE ALSO
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +0000171.BR Xvnc (1),
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000172.BR vncpasswd (1),
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000173.br
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +0000174http://www.tightvnc.com/
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000175.SH AUTHOR
Constantin Kaplinskya9ec0e82008-01-07 13:57:01 +0000176This manual page was written by Constantin Kaplinsky.