Pierre Ossman | f256a1a | 2014-09-17 14:09:58 +0200 | [diff] [blame] | 1 | .TH X0VNCSERVER 1 "" "TigerVNC" "TigerVNC Manual" |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 2 | .SH NAME |
Peter Åstrand | 4eacc02 | 2009-02-27 10:12:14 +0000 | [diff] [blame] | 3 | x0vncserver \- TigerVNC Server for 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 |
Peter Åstrand | 4eacc02 | 2009-02-27 10:12:14 +0000 | [diff] [blame] | 11 | is a TigerVNC Server which makes any X display remotely accessible via VNC, |
| 12 | TigerVNC or compatible viewers. Unlike \fBXvnc\fP(1), it does not create a |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 13 | virtual display. Instead, it just shares an existing X server (typically, |
| 14 | that one connected to the physical screen). |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 15 | |
| 16 | XDamage will be used if the existing X server supports it. Otherwise |
| 17 | .B x0vncserver |
| 18 | will fall back to polling the screen for changes. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 19 | |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 20 | .SH OPTIONS |
| 21 | .B x0vncserver |
| 22 | interprets the command line as a list of parameters with optional values. |
| 23 | 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] | 24 | short descriptions. All parameters are optional, but normally you would have |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 25 | to use the \fBPasswordFile\fP parameter (see its description below). |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 26 | .PP |
| 27 | There are several forms of specifying parameters in the command line (here we |
| 28 | use `\fISomeParameter\fP' as an example parameter name): |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 29 | |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 30 | .TP |
| 31 | .B -\fISomeParameter\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 32 | 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] | 33 | parameters that simply enable or disable some feature. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 34 | . |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 35 | .TP |
| 36 | .B -\fISomeParameter\fP=0 |
| 37 | Disable the parameter, turn the feature off. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 38 | . |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 39 | .TP |
| 40 | .B -\fISomeParameter\fP=\fIvalue\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 41 | Assign the specified \fIvalue\fP to the parameter. The leading dash can be |
| 42 | 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] | 43 | .PP |
| 44 | Parameter names are case-insensitive, their order in the command line can be |
| 45 | arbitrary. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 46 | |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 47 | .SH PARAMETERS |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 48 | |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 49 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 50 | .B \-display \fIdisplay\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 51 | The X display name. If not specified, it defaults to the value of the |
| 52 | DISPLAY environment variable. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 53 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 54 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 55 | .B \-rfbport \fIport\fP |
| 56 | Specifies the TCP port on which x0vncserver listens for connections from |
| 57 | viewers (the protocol used in VNC is called RFB - "remote framebuffer"). |
| 58 | The default port is 5900. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 59 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 60 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 61 | .B \-Log \fIlogname\fP:\fIdest\fP:\fIlevel\fP |
| 62 | Configures the debug log settings. \fIdest\fP can currently be \fBstderr\fP, |
| 63 | \fBstdout\fP or \fBsyslog\fP, and \fIlevel\fP is between 0 and 100, 100 meaning |
| 64 | most verbose output. \fIlogname\fP is usually \fB*\fP meaning all, but you can |
| 65 | target a specific source file if you know the name of its "LogWriter". Default |
| 66 | is \fB*:stderr:30\fP. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 67 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 68 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 69 | .B \-HostsFile \fIfilename\fP |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 70 | This parameter allows to specify a file name with IP access control rules. |
| 71 | The file should include one rule per line, and the rule format is one of the |
Pierre Ossman | 14e214f | 2015-08-10 11:31:14 +0200 | [diff] [blame] | 72 | following: +\fIaddress\fP/\fIprefix\fP (accept connections from the |
| 73 | specified address group), -\fIaddress\fP/\fIprefix\fP (reject connections) |
| 74 | or ?\fIaddress\fP/\fIprefix\fP (query the local user). The first rule |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 75 | matching the IP address determines the action to be performed. Rules that |
| 76 | include only an action sign (+, - or ?) will match any IP address. |
Pierre Ossman | 14e214f | 2015-08-10 11:31:14 +0200 | [diff] [blame] | 77 | \fIPrefix\fP is optional and is specified as a number of bits (e.g. /24). |
| 78 | Default is to accept connections from any IP address. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 79 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 80 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 81 | .B \-SecurityTypes \fIsec-types\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 82 | Specify which security scheme to use for incoming connections. Valid values |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 83 | are a comma separated list of \fBNone\fP, \fBVncAuth\fP, \fBPlain\fP, |
| 84 | \fBTLSNone\fP, \fBTLSVnc\fP, \fBTLSPlain\fP, \fBX509None\fP, \fBX509Vnc\fP |
| 85 | and \fBX509Plain\fP. Default is \fBVncAuth,TLSVnc\fP. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 86 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 87 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 88 | .B \-rfbauth \fIpasswd-file\fP, \-PasswordFile \fIpasswd-file\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 89 | Password file for VNC authentication. There is no default, you should |
| 90 | specify the password file explicitly. Password file should be created with |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 91 | the \fBvncpasswd\fP(1) utility. The file is accessed each time a connection |
| 92 | comes in, so it can be changed on the fly. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 93 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 94 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 95 | .B \-Password \fIpassword\fP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 96 | Obfuscated binary encoding of the password which clients must supply to |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 97 | access the server. Using this parameter is insecure, use \fBPasswordFile\fP |
| 98 | parameter instead. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 99 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 100 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 101 | .B \-PlainUsers \fIuser-list\fP |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 102 | A comma separated list of user names that are allowed to authenticate via |
| 103 | any of the "Plain" security types (Plain, TLSPlain, etc.). Specify \fB*\fP |
| 104 | to allow any user to authenticate using this security type. Default is to |
| 105 | deny all users. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 106 | . |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 107 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 108 | .B \-pam_service \fIname\fP, \-PAMService \fIname\fP |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 109 | PAM service name to use when authentication users using any of the "Plain" |
| 110 | security types. Default is \fBvnc\fP. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 111 | . |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 112 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 113 | .B \-X509Cert \fIpath\fP |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 114 | Path to a X509 certificate in PEM format to be used for all X509 based |
| 115 | security types (X509None, X509Vnc, etc.). |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 116 | . |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 117 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 118 | .B \-X509Key \fIpath\fP |
Pierre Ossman | 3d2a84b | 2014-09-17 16:45:35 +0200 | [diff] [blame] | 119 | Private key counter part to the certificate given in \fBX509Cert\fP. Must |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 120 | also be in PEM format. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 121 | . |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 122 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 123 | .B \-BlacklistThreshold \fIcount\fP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 124 | The number of unauthenticated connection attempts allowed from any individual |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 125 | host before that host is black-listed. Default is 5. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 126 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 127 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 128 | .B \-BlacklistTimeout \fIseconds\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 129 | The initial timeout applied when a host is first black-listed. The host |
| 130 | cannot re-attempt a connection until the timeout expires. Default is 10. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 131 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 132 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 133 | .B \-QueryConnect |
| 134 | Prompts the user of the desktop to explicitly accept or reject incoming |
| 135 | connections. Default is off. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 136 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 137 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 138 | .B \-QueryConnectTimeout \fIseconds\fP |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 139 | Number of seconds to show the Accept Connection dialog before rejecting the |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 140 | connection. Default is \fB10\fP. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 141 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 142 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 143 | .B \-AlwaysShared |
| 144 | Always treat incoming connections as shared, regardless of the client-specified |
| 145 | setting. Default is off. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 146 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 147 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 148 | .B \-NeverShared |
| 149 | Never treat incoming connections as shared, regardless of the client-specified |
| 150 | setting. Default is off. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 151 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 152 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 153 | .B \-DisconnectClients |
| 154 | Disconnect existing clients if an incoming connection is non-shared. Default is |
| 155 | on. If \fBDisconnectClients\fP is false, then a new non-shared connection will |
| 156 | be refused while there is a client active. When combined with |
| 157 | \fBNeverShared\fP this means only one client is allowed at a time. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 158 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 159 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 160 | .B \-AcceptKeyEvents |
| 161 | Accept key press and release events from clients. Default is on. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 162 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 163 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 164 | .B \-AcceptPointerEvents |
| 165 | Accept pointer press and release events from clients. Default is on. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 166 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 167 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 168 | .B \-RemapKeys \fImapping |
| 169 | Sets up a keyboard mapping. |
| 170 | .I mapping |
| 171 | is a comma-separated string of character mappings, each of the form |
| 172 | .IR char -> char , |
| 173 | or |
| 174 | .IR char <> char , |
| 175 | where |
| 176 | .I char |
| 177 | is a hexadecimal keysym. For example, to exchange the " and @ symbols you would specify the following: |
| 178 | |
| 179 | .RS 10 |
| 180 | RemapKeys=0x22<>0x40 |
| 181 | .RE |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 182 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 183 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 184 | .B \-RawKeyboard |
Peter Korsgaard | 8fe5090 | 2017-07-13 00:35:57 +0200 | [diff] [blame] | 185 | Send keyboard events straight through and avoid mapping them to the current |
| 186 | keyboard layout. This effectively makes the keyboard behave according to the |
| 187 | layout configured on the server instead of the layout configured on the |
| 188 | client. Default is off. |
| 189 | . |
| 190 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 191 | .B \-Protocol3.3 |
| 192 | Always use protocol version 3.3 for backwards compatibility with badly-behaved |
| 193 | clients. Default is off. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 194 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 195 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 196 | .B \-Geometry \fIgeometry\fP |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 197 | This option specifies the screen area that will be shown to VNC clients. The |
| 198 | format is |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 199 | .B \fIwidth\fPx\fIheight\fP+\fIxoffset\fP+\fIyoffset\fP |
Constantin Kaplinsky | f32f885 | 2008-12-23 07:44:39 +0000 | [diff] [blame] | 200 | , where `+' signs can be replaced with `\-' signs to specify offsets from the |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 201 | right and/or from the bottom of the screen. Offsets are optional, +0+0 is |
| 202 | assumed by default (top left corner). If the argument is empty, full screen |
| 203 | is shown to VNC clients (this is the default). |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 204 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 205 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 206 | .B \-MaxProcessorUsage \fIpercent\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 207 | Maximum percentage of CPU time to be consumed when polling the |
| 208 | screen. Default is 35. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 209 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 210 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 211 | .B \-PollingCycle \fImilliseconds\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 212 | Milliseconds per one polling cycle. Actual interval may be dynamically |
| 213 | adjusted to satisfy \fBMaxProcessorUsage\fP setting. Default is 30. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 214 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 215 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 216 | .B \-CompareFB \fImode\fP |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 217 | Perform pixel comparison on framebuffer to reduce unnecessary updates. Can |
| 218 | be either \fB0\fP (off), \fB1\fP (always) or \fB2\fP (auto). Default is |
| 219 | \fB2\fP. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 220 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 221 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 222 | .B \-UseSHM |
Constantin Kaplinsky | b8363be | 2008-01-08 13:48:19 +0000 | [diff] [blame] | 223 | Use MIT-SHM extension if available. Using that extension accelerates reading |
| 224 | the screen. Default is on. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 225 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 226 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 227 | .B \-ZlibLevel \fIlevel\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 228 | Zlib compression level for ZRLE encoding (it does not affect Tight encoding). |
| 229 | Acceptable values are between 0 and 9. Default is to use the standard |
| 230 | compression level provided by the \fBzlib\fP(3) compression library. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 231 | . |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 232 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 233 | .B \-ImprovedHextile |
Constantin Kaplinsky | 8d61d0d | 2008-01-07 16:10:37 +0000 | [diff] [blame] | 234 | Use improved compression algorithm for Hextile encoding which achieves better |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 235 | compression ratios by the cost of using slightly more CPU time. Default is |
| 236 | on. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 237 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 238 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 239 | .B \-IdleTimeout \fIseconds\fP |
| 240 | The number of seconds after which an idle VNC connection will be dropped. |
| 241 | Default is 0, which means that idle connections will never be dropped. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 242 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 243 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 244 | .B \-MaxDisconnectionTime \fIseconds\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 245 | Terminate when no client has been connected for \fIN\fP seconds. Default is |
| 246 | 0. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 247 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 248 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 249 | .B \-MaxConnectionTime \fIseconds\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 250 | Terminate when a client has been connected for \fIN\fP seconds. Default is |
| 251 | 0. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 252 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 253 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 254 | .B \-MaxIdleTime \fIseconds\fP |
Constantin Kaplinsky | 5974008 | 2008-01-08 10:42:22 +0000 | [diff] [blame] | 255 | Terminate after \fIN\fP seconds of user inactivity. Default is 0. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 256 | . |
Constantin Kaplinsky | cef4577 | 2008-01-07 14:52:51 +0000 | [diff] [blame] | 257 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 258 | .B \-ClientWaitTimeMillis \fItime\fP |
| 259 | Time in milliseconds to wait for a viewer which is blocking the server. This is |
| 260 | necessary because the server is single-threaded and sometimes blocks until the |
| 261 | viewer has finished sending or receiving a message - note that this does not |
| 262 | mean an update will be aborted after this time. Default is 20000 (20 seconds). |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 263 | . |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 264 | .TP |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 265 | .B \-AcceptCutText |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 266 | .TQ |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 267 | .B \-SendCutText |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 268 | .TQ |
Pierre Ossman | 8ddfd94 | 2018-02-05 10:47:27 +0100 | [diff] [blame^] | 269 | .B \-MaxCutText |
Pierre Ossman | de0f832 | 2014-09-17 15:43:14 +0200 | [diff] [blame] | 270 | Currently unused. |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 271 | |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 272 | .SH SEE ALSO |
Constantin Kaplinsky | a9ec0e8 | 2008-01-07 13:57:01 +0000 | [diff] [blame] | 273 | .BR Xvnc (1), |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 274 | .BR vncpasswd (1), |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 275 | .br |
Peter Åstrand | 4eacc02 | 2009-02-27 10:12:14 +0000 | [diff] [blame] | 276 | http://www.tigervnc.org/ |
Pierre Ossman | 23f67c3 | 2014-09-17 16:28:56 +0200 | [diff] [blame] | 277 | |
Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 278 | .SH AUTHOR |
Pierre Ossman | e37a144 | 2014-09-17 14:08:16 +0200 | [diff] [blame] | 279 | Constantin Kaplinsky and others. |
| 280 | |
| 281 | VNC was originally developed by the RealVNC team while at Olivetti |
| 282 | Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were |
| 283 | implemented by Constantin Kaplinsky. Many other people have since |
| 284 | participated in development, testing and support. This manual is part |
| 285 | of the TigerVNC software suite. |