Constantin Kaplinsky | 2039d7b | 2008-06-04 10:43:10 +0000 | [diff] [blame] | 1 | .TH X0VNCSERVER 1 "Jun 04, 2008" "TightVNC" "TightVNC Manual" |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 2 | .SH NAME |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 3 | x0vncserver \- TightVNC Server for real X displays |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 4 | .SH SYNOPSIS |
| 5 | .B x0vncserver |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 6 | .RI [ options ] |
Constantin Kaplinsky | 2039d7b | 2008-06-04 10:43:10 +0000 | [diff] [blame] | 7 | .br |
| 8 | .B x0vncserver -version |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 9 | .SH DESCRIPTION |
| 10 | .B x0vncserver |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 11 | is a TightVNC Server which makes any X display remotely accessible via VNC, |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 12 | TightVNC or compatible viewers. Unlike \fBXvnc\fP(1), it does not create a |
| 13 | virtual display. Instead, it just shares an existing X server (typically, |
| 14 | that one connected to the physical screen). |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 15 | .SH OPTIONS |
| 16 | .B x0vncserver |
| 17 | interprets the command line as a list of parameters with optional values. |
| 18 | Running \fBx0vncserver -h\fP will show a list of all valid parameters with |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 19 | short descriptions. All parameters are optional, but normally you would have |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 20 | to use the \fBPasswordFile\fP parameter (see its description below). |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 21 | .PP |
| 22 | There are several forms of specifying parameters in the command line (here we |
| 23 | use `\fISomeParameter\fP' as an example parameter name): |
| 24 | .TP |
| 25 | .B -\fISomeParameter\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 26 | Enable the parameter, turn the feature on. This form can be used with |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 27 | parameters that simply enable or disable some feature. |
| 28 | .TP |
| 29 | .B -\fISomeParameter\fP=0 |
| 30 | Disable the parameter, turn the feature off. |
| 31 | .TP |
| 32 | .B -\fISomeParameter\fP=\fIvalue\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 33 | Assign the specified \fIvalue\fP to the parameter. The leading dash can be |
| 34 | omitted, or it can be doubled if desired (like in GNU-style long options). |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 35 | .PP |
| 36 | Parameter names are case-insensitive, their order in the command line can be |
| 37 | arbitrary. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 38 | .SH PARAMETERS |
| 39 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 40 | .B display |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 41 | The X display name. If not specified, it defaults to the value of the |
| 42 | DISPLAY environment variable. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 43 | .TP |
| 44 | .B rfbport |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 45 | TCP port to listen for incoming VNC connections (RFB protocol). The default |
| 46 | port is 5900. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 47 | .TP |
| 48 | .B Log |
| 49 | Specifies which log output should be directed to which target logger, and the |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 50 | level of output to log. Format is \fIlog\fP:\fItarget\fP:\fIlevel\fP. |
| 51 | Default is \fB*:stderr:30\fP (log everything to stderr, set log level to 30). |
| 52 | Log level should be a value between 0 and 100, higher levels produce more |
| 53 | output. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 54 | .TP |
| 55 | .B HostsFile |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 56 | This parameter allows to specify a file name with IP access control rules. |
| 57 | The file should include one rule per line, and the rule format is one of the |
| 58 | following: +\fIaddress\fP/\fInetmask\fP (accept connections from the |
| 59 | specified address group), -\fIaddress\fP/\fInetmask\fP (reject connections) |
| 60 | or ?\fIaddress\fP/\fInetmask\fP (query the local user). The first rule |
| 61 | matching the IP address determines the action to be performed. Rules that |
| 62 | include 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 |
| 65 | to accept connections from any IP address. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 66 | .TP |
| 67 | .B SecurityTypes |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 68 | Specify which security scheme to use for incoming connections. Valid values |
| 69 | are \fBNone\fP and \fBVncAuth\fP. Default is \fBVncAuth\fP. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 70 | .TP |
| 71 | .B PasswordFile |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 72 | Password file for VNC authentication. There is no default, you should |
| 73 | specify the password file explicitly. Password file should be created with |
| 74 | the \fBvncpasswd\fP(1) utility. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 75 | .TP |
| 76 | .B Password |
| 77 | Obfuscated binary encoding of the password which clients must supply to |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 78 | access the server. Using this parameter is insecure, use \fBPasswordFile\fP |
| 79 | parameter instead. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 80 | .TP |
| 81 | .B BlacklistThreshold |
| 82 | The number of unauthenticated connection attempts allowed from any individual |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 83 | host before that host is black-listed. Default is 5. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 84 | .TP |
| 85 | .B BlacklistTimeout |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 86 | The initial timeout applied when a host is first black-listed. The host |
| 87 | cannot re-attempt a connection until the timeout expires. Default is 10. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 88 | .TP |
| 89 | .B QueryConnect |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 90 | Prompt the local user to accept or reject incoming connections. Default is |
| 91 | off. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 92 | .TP |
| 93 | .B QueryConnectTimeout |
| 94 | Number of seconds to show the Accept Connection dialog before rejecting the |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 95 | connection. Default is 10. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 96 | .TP |
| 97 | .B AlwaysShared |
| 98 | Always treat incoming connections as shared, regardless of the |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 99 | client-specified setting. Default is off. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 100 | .TP |
| 101 | .B NeverShared |
| 102 | Never treat incoming connections as shared, regardless of the |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 103 | client-specified setting. Default is off. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 104 | .TP |
| 105 | .B DisconnectClients |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 106 | Disconnect existing clients if an incoming connection is non-shared. If |
| 107 | combined with \fBNeverShared\fP then new connections will be refused while |
| 108 | there is a client active. Default is on. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 109 | .TP |
| 110 | .B AcceptKeyEvents |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 111 | Accept key press and release events from clients. Default is on. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 112 | .TP |
| 113 | .B AcceptPointerEvents |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 114 | Accept pointer events from clients. Default is on. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 115 | .TP |
| 116 | .B RemapKeys |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 117 | Comma-separated list of incoming keysyms to remap. Mappings are expressed as |
| 118 | two hex values, prefixed by \fB0x\fP, and separated by \fB->\fP (`dash' and |
| 119 | `greater than' characters). |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 120 | .TP |
| 121 | .B Protocol3.3 |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 122 | Always use RFB protocol version 3.3 for backwards compatibility with |
| 123 | badly-behaved clients. Default is off. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 124 | .TP |
| 125 | .B Geometry |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 126 | This option specifies the screen area that will be shown to VNC clients. The |
| 127 | format is |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 128 | .B \fIwidth\fPx\fIheight\fP+\fIxoffset\fP+\fIyoffset\fP |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 129 | , where `+' signs can be replaced with `-' signs to specify offsets from the |
| 130 | right and/or from the bottom of the screen. Offsets are optional, +0+0 is |
| 131 | assumed by default (top left corner). If the argument is empty, full screen |
| 132 | is shown to VNC clients (this is the default). |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 133 | .TP |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 134 | .B MaxProcessorUsage |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 135 | Maximum percentage of CPU time to be consumed when polling the |
| 136 | screen. Default is 35. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 137 | .TP |
| 138 | .B PollingCycle |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 139 | Milliseconds per one polling cycle. Actual interval may be dynamically |
| 140 | adjusted to satisfy \fBMaxProcessorUsage\fP setting. Default is 30. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 141 | .TP |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 142 | .B CompareFB |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 143 | Perform pixel comparison on framebuffer to reduce unnecessary updates. |
| 144 | Default is on. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 145 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 146 | .B UseSHM |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 147 | Use MIT-SHM extension if available. Using that extension accelerates reading |
| 148 | the screen. Default is on. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 149 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 150 | .B OverlayMode |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 151 | Use overlay mode in IRIX or Solaris (does not have effect in other systems). |
| 152 | This enables system-specific access to complete full-color version of the |
| 153 | screen (the default X visual often provides 256 colors). Also, in overlay |
| 154 | mode, \fBx0vncserver\fP can show correct mouse cursor. Default is on. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 155 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 156 | .B UseHardwareJPEG |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 157 | Use hardware-accelerated JPEG compressor for video if available. |
| 158 | \fBx0vncserver\fP can detect video areas on the screen and handle them |
| 159 | separately from the rest of the screen, for better performance. If the |
| 160 | client supports Tight encoding and JPEG compression, such video areas will be |
| 161 | sent as JPEG-encoded rectangles. And if this option is on, compression will |
| 162 | be hardware-accelerated (currently, supported only in SGI/IRIX equipped with |
| 163 | appropriate hardware). Default is on. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 164 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 165 | .B ZlibLevel |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 166 | Zlib compression level for ZRLE encoding (it does not affect Tight encoding). |
| 167 | Acceptable values are between 0 and 9. Default is to use the standard |
| 168 | compression level provided by the \fBzlib\fP(3) compression library. |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 169 | .TP |
| 170 | .B ImprovedHextile |
| 171 | Use improved compression algorithm for Hextile encoding which achieves better |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 172 | compression ratios by the cost of using slightly more CPU time. Default is |
| 173 | on. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 174 | .TP |
| 175 | .B IdleTimeout |
| 176 | The number of seconds after which an idle VNC connection will be dropped |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 177 | (zero means no timeout). Default is 0. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 178 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 179 | .B MaxDisconnectionTime |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 180 | Terminate when no client has been connected for \fIN\fP seconds. Default is |
| 181 | 0. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 182 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 183 | .B MaxConnectionTime |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 184 | Terminate when a client has been connected for \fIN\fP seconds. Default is |
| 185 | 0. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 186 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 187 | .B MaxIdleTime |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 188 | Terminate after \fIN\fP seconds of user inactivity. Default is 0. |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 189 | .TP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 190 | .B ClientWaitTimeMillis |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 191 | The number of milliseconds to wait for a client which is no longer |
| 192 | responding. Default is 20000. |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 193 | .SH SEE ALSO |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 194 | .BR Xvnc (1), |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 195 | .BR vncpasswd (1), |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 196 | .br |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 197 | http://www.tightvnc.com/ |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 198 | .SH AUTHOR |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 199 | This manual page was written by Constantin Kaplinsky. |