diff --git a/unix/xserver/hw/vnc/Xvnc.man b/unix/xserver/hw/vnc/Xvnc.man index 04e8f94..cfccf4e 100644 --- a/unix/xserver/hw/vnc/Xvnc.man +++ b/unix/xserver/hw/vnc/Xvnc.man @@ -1,9 +1,9 @@ .TH Xvnc 1 "" "TigerVNC" "Virtual Network Computing" .SH NAME -Xvnc \- the X VNC server +Xvnc \- the X VNC server .SH SYNOPSIS .B Xvnc -.RI [ options ] +.RI [ options ] .RI : display# .SH DESCRIPTION .B Xvnc @@ -52,7 +52,7 @@ for depth 16 is RGB565 and for depth 24 is RGB888. Listen on interface. By default Xvnc listens on all available interfaces. . .TP -.B \-inetd +.B \-inetd This significantly changes Xvnc's behaviour so that it can be launched from inetd. See the section below on usage with inetd. . @@ -83,12 +83,19 @@ protocol used in VNC is called RFB - "remote framebuffer"). The default is 5900 plus the display number. . .TP +.B \-UseIPv4 +Use IPv4 for incoming and outgoing connections. Default is on. +. +.TP +.B \-UseIPv6 +Use IPv6 for incoming and outgoing connections. Default is on. +. +.TP .B \-rfbwait \fItime\fP, \-ClientWaitTimeMillis \fItime\fP - -Time in milliseconds to wait for a viewer which is blocking Xvnc. This is -necessary because Xvnc is single-threaded and sometimes blocks until the viewer -has finished sending or receiving a message - note that this does not mean an -update will be aborted after this time. Default is 20000 (20 seconds). +Time in milliseconds to wait for a viewer which is blocking the server. This is +necessary because the server is single-threaded and sometimes blocks until the +viewer has finished sending or receiving a message - note that this does not +mean an update will be aborted after this time. Default is 20000 (20 seconds). . .TP .B \-httpd \fIdirectory\fP @@ -105,29 +112,14 @@ the display number. . .TP .B \-rfbauth \fIpasswd-file\fP, \-PasswordFile \fIpasswd-file\fP -Specifies the file containing the password used to authenticate viewers. The -file is accessed each time a connection comes in, so it can be changed on the -fly via \fBvncpasswd\fP(1). -. -.TP -.B \-DeferUpdate \fItime\fP -Xvnc uses a "deferred update" mechanism which enhances performance in many -cases. After any change to the framebuffer, Xvnc waits for this number of -milliseconds (default 1) before sending an update to any waiting clients. This -means that more changes tend to get coalesced together in a single -update. Setting it to 0 results in the same behaviour as earlier versions of -Xvnc, where the first change to the framebuffer causes an immediate update to -any waiting clients. -. -.TP -.B \-AlwaysSetDeferUpdateTimer -Keep delaying sending the screen update to the client(s) each time the -screen is updated. Otherwise the delay is from the first update. Default -is off. +Password file for VNC authentication. There is no default, you should +specify the password file explicitly. Password file should be created with +the \fBvncpasswd\fP(1) utility. The file is accessed each time a connection +comes in, so it can be changed on the fly. . .TP .B \-AcceptCutText -Accept clipboard updates from clients (default is on). +Accept clipboard updates from clients. Default is on. . .TP .B \-MaxCutText \fIbytes\fP @@ -136,7 +128,7 @@ Default is \fB262144\fP. . .TP .B \-SendCutText -Send clipboard changes to clients (default is on). +Send clipboard changes to clients. Default is on. . .TP .B \-SendPrimary @@ -144,42 +136,58 @@ Send the primary selection and cut buffer to the server as well as the clipboard selection. Default is on. . .TP +.B \-SetPrimary +Set the PRIMARY as well as the CLIPBOARD selection. Default is on. +. +.TP .B \-AcceptPointerEvents -Accept pointer press and release events from clients (default is on). +Accept pointer press and release events from clients. Default is on. . .TP .B \-AcceptKeyEvents -Accept key press and release events from clients (default is on). +Accept key press and release events from clients. Default is on. +. +.TP +.B \-AcceptSetDesktopSize +Accept requests to resize the size of the desktop. Default is on. . .TP .B \-DisconnectClients -Disconnect existing clients if an incoming connection is non-shared (default is -on). If \fBDisconnectClients\fP is false, then a new non-shared connection will +Disconnect existing clients if an incoming connection is non-shared. Default is +on. If \fBDisconnectClients\fP is false, then a new non-shared connection will be refused while there is a client active. When combined with \fBNeverShared\fP this means only one client is allowed at a time. . .TP .B \-NeverShared Never treat incoming connections as shared, regardless of the client-specified -setting (default is off). +setting. Default is off. . .TP .B \-AlwaysShared Always treat incoming connections as shared, regardless of the client-specified -setting (default is off). +setting. Default is off. . .TP .B \-Protocol3.3 Always use protocol version 3.3 for backwards compatibility with badly-behaved -clients (default is off). +clients. Default is off. . .TP -.B \-CompareFB -Perform pixel comparison on framebuffer to reduce unnecessary updates (default -is on). +.B \-FrameRate \fIfps\fP +The maximum number of updates per second sent to each client. If the screen +updates any faster then those changes will be aggregated and sent in a single +update to the client. Note that this only controls the maximum rate and a +client may get a lower rate when resources are limited. Default is \fB60\fP. . .TP -.B \-ZlibLevel +.B \-CompareFB \fImode\fP +Perform pixel comparison on framebuffer to reduce unnecessary updates. Can +be either \fB0\fP (off), \fB1\fP (always) or \fB2\fP (auto). Default is +\fB2\fP. +. +.TP +.B \-ZlibLevel \fIlevel\fP Zlib compression level for ZRLE encoding (it does not affect Tight encoding). Acceptable values are between 0 and 9. Default is to use the standard compression level provided by the \fBzlib\fP(3) compression library. @@ -226,6 +234,11 @@ Private key counter part to the certificate given in \fBX509Cert\fP. Must also be in PEM format. . .TP +.B \-GnuTLSPriority \fIpriority\fP +GnuTLS priority string that controls the TLS session’s handshake algorithms. +See the GnuTLS manual for possible values. Default is \fBNORMAL\fP. +. +.TP .B \-BlacklistThreshold \fIcount\fP The number of unauthenticated connection attempts allowed from any individual host before that host is black-listed. Default is 5. @@ -237,8 +250,8 @@ cannot re-attempt a connection until the timeout expires. Default is 10. . .TP .B \-IdleTimeout \fIseconds\fP -The number of seconds after which an idle VNC connection will be dropped -(default is 0, which means that idle connections will never be dropped). +The number of seconds after which an idle VNC connection will be dropped. +Default is 0, which means that idle connections will never be dropped. . .TP .B \-MaxDisconnectionTime \fIseconds\fP @@ -257,13 +270,10 @@ Terminate after \fIN\fP seconds of user inactivity. Default is 0. .TP .B \-QueryConnect Prompts the user of the desktop to explicitly accept or reject incoming -connections. This is most useful when using the vnc.so module or -\fBx0vncserver\fP(1) program to access an existing X desktop via VNC. +connections. Default is off. The \fBvncconfig\fP(1) program must be running on the desktop in order for -QueryConnect to be supported by the \fBvnc.so\fP(1) module or -\fBXvnc\fP(1) program. The \fBx0vncserver\fP(1) program does not require -\fBvncconfig\fP(1) to be running. +QueryConnect to be supported. . .TP .B \-QueryConnectTimeout \fIseconds\fP @@ -294,8 +304,10 @@ or where .I char is a hexadecimal keysym. For example, to exchange the " and @ symbols you would specify the following: -.IP "" 10 + +.RS 10 RemapKeys=0x22<>0x40 +.RE . .TP .B \-AvoidShiftNumLock