summaryrefslogtreecommitdiffstats
path: root/unix/xserver/hw/vnc/Xvnc.man
diff options
context:
space:
mode:
authorPierre Ossman <ossman@cendio.se>2014-09-17 15:43:14 +0200
committerPierre Ossman <ossman@cendio.se>2014-09-17 15:43:14 +0200
commitde0f832a05379575adf42c27b1c68809a9818359 (patch)
tree7a7de4be1e1c718ddc928c7db1508ece6913e492 /unix/xserver/hw/vnc/Xvnc.man
parentc16bb2783655e5ea5fbd9dc87ed53405759cdd71 (diff)
downloadtigervnc-de0f832a05379575adf42c27b1c68809a9818359.tar.gz
tigervnc-de0f832a05379575adf42c27b1c68809a9818359.zip
Update server man pages to reflect current list of options
Diffstat (limited to 'unix/xserver/hw/vnc/Xvnc.man')
-rw-r--r--unix/xserver/hw/vnc/Xvnc.man111
1 files changed, 94 insertions, 17 deletions
diff --git a/unix/xserver/hw/vnc/Xvnc.man b/unix/xserver/hw/vnc/Xvnc.man
index 853ef8c8..ea61c6b9 100644
--- a/unix/xserver/hw/vnc/Xvnc.man
+++ b/unix/xserver/hw/vnc/Xvnc.man
@@ -52,15 +52,6 @@ for depth 16 is RGB565 and for depth 24 is RGB888.
Listen on interface. By default Xvnc listens on all available interfaces.
.TP
-.B \-cc 3
-As an alternative to the default TrueColor visual, this allows you to run an
-Xvnc server with a PseudoColor visual (i.e. one which uses a color map or
-palette), which can be useful for running some old X applications which only
-work on such a display. Values other than 3 (PseudoColor) and 4 (TrueColor)
-for the \-cc option may result in strange behaviour, and PseudoColor desktops
-must be 8 bits deep (i.e. \fB-depth 8\fP).
-
-.TP
.B \-inetd
This significantly changes Xvnc's behaviour so that it can be launched from
inetd. See the section below on usage with inetd.
@@ -119,7 +110,7 @@ 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
+.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
@@ -129,6 +120,12 @@ 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.
+
+.TP
.B \-SendCutText
Send clipboard changes to clients (default is on). Note that you must also run
\fBvncconfig\fP(1) to get the clipboard to work.
@@ -139,6 +136,11 @@ Accept clipboard updates from clients (default is on). Note that you must also
run \fBvncconfig\fP(1) to get the clipboard to work.
.TP
+.B \-MaxCutText \fIbytes\fP
+The maximum size of a clipboard update that will be accepted from a client.
+Default is \fB262144\fP.
+
+.TP
.B \-AcceptPointerEvents
Accept pointer press and release events from clients (default is on).
@@ -174,11 +176,61 @@ Perform pixel comparison on framebuffer to reduce unnecessary updates (default
is on).
.TP
+.B \-ZlibLevel
+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.
+
+.TP
+.B \-ImprovedHextile
+Use improved compression algorithm for Hextile encoding which achieves better
+compression ratios by the cost of using slightly more CPU time. Default is
+on.
+
+.TP
.B \-SecurityTypes \fIsec-types\fP
-Specify which security schemes to use separated by commas. At present only
-"None" and "VncAuth" are supported. The default is "VncAuth" - note that if
-you want a server which does not require a password, you must set this
-parameter to "None".
+Specify which security scheme to use for incoming connections. Valid values
+are a comma separated list of \fBNone\fP, \fBVncAuth\fP, \fBPlain\fP,
+\fBTLSNone\fP, \fBTLSVnc\fP, \fBTLSPlain\fP, \fBX509None\fP, \fBX509Vnc\fP
+and \fBX509Plain\fP. Default is \fBVncAuth,TLSVnc\fP.
+
+.TP
+.B \-Password \fIpassword\fP
+Obfuscated binary encoding of the password which clients must supply to
+access the server. Using this parameter is insecure, use \fBPasswordFile\fP
+parameter instead.
+
+.TP
+.B \-PlainUsers \fIuser-list\fP
+A comma separated list of user names that are allowed to authenticate via
+any of the "Plain" security types (Plain, TLSPlain, etc.). Specify \fB*\fP
+to allow any user to authenticate using this security type. Default is to
+deny all users.
+
+.TP
+.B \-pam_service \fIname\fP
+PAM service name to use when authentication users using any of the "Plain"
+security types. Default is \fBvnc\fP.
+
+.TP
+.B \-x509cert \fIpath\fP
+Path to a X509 certificate in PEM format to be used for all X509 based
+security types (X509None, X509Vnc, etc.).
+
+.TP
+.B \-x509key \fIpath\fP
+Private key counter part to the certificate given in \fBx509cert\fP. Must
+also be in PEM format.
+
+.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.
+
+.TP
+.B \-BlacklistTimeout \fIseconds\fP
+The initial timeout applied when a host is first black-listed. The host
+cannot re-attempt a connection until the timeout expires. Default is 10.
.TP
.B \-IdleTimeout \fIseconds\fP
@@ -186,6 +238,20 @@ 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
+Terminate when no client has been connected for \fIN\fP seconds. Default is
+0.
+
+.TP
+.B \-MaxConnectionTime \fIseconds\fP
+Terminate when a client has been connected for \fIN\fP seconds. Default is
+0.
+
+.TP
+.B \-MaxIdleTime \fIseconds\fP
+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
@@ -197,13 +263,17 @@ QueryConnect to be supported by the \fBvnc.so\fP(1) module or
\fBvncconfig\fP(1) to be running.
.TP
+.B \-QueryConnectTimeout \fIseconds\fP
+Number of seconds to show the Accept Connection dialog before rejecting the
+connection. Default is \fB10\fP.
+
+.TP
.B \-localhost
Only allow connections from the same machine. Useful if you use SSH and want to
-stop non-SSH connections from any other hosts. See the guide to using VNC with
-SSH on the web site.
+stop non-SSH connections from any other hosts.
.TP
-.B \-log \fIlogname\fP:\fIdest\fP:\fIlevel\fP
+.B \-Log \fIlogname\fP:\fIdest\fP:\fIlevel\fP
Configures the debug log settings. \fIdest\fP can currently be \fBstderr\fP or
\fBstdout\fP, and \fIlevel\fP is between 0 and 100, 100 meaning most verbose
output. \fIlogname\fP is usually \fB*\fP meaning all, but you can target a
@@ -224,6 +294,13 @@ is a hexadecimal keysym. For example, to exchange the " and @ symbols you would
.IP "" 10
RemapKeys=0x22<>0x40
+.TP
+.B \-AvoidShiftNumLock
+Key affected by NumLock often require a fake Shift to be inserted in order
+for the correct symbol to be generated. Turning on this option avoids these
+extra fake Shift events but may result in a slightly different symbol
+(e.g. a Return instead of a keypad Enter).
+
.SH USAGE WITH INETD
By configuring the \fBinetd\fP(1) service appropriately, Xvnc can be launched
on demand when a connection comes in, rather than having to be started