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