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