server). \fIhost\fP is the host where the listening viewer is running. If it's
not listening on the default port of 5500, you can specify \fIhost:port\fP
instead.
-
+.
.TP
.B \-disconnect
This causes Xvnc to disconnect from all viewers so that the VNC desktop is not
displayed anywhere.
-
+.
.TP
[\fB-set\fP] \fIXvnc-param\fP=\fIvalue\fP
Sets an Xvnc parameter to the given value. Note that some of Xvnc's parameters
are read only once at startup so that changing them in this way may not have
any effect.
-
+.
.TP
.B \-list
Lists all the parameters supported by Xvnc.
-
+.
.TP
.B \-get \fIXvnc-param\fP
Prints the current value of the given Xvnc parameter.
-
+.
.TP
.B \-desc \fIXvnc-param\fP
Prints a short description of the given Xvnc parameter.
.TP
.B \-display \fIXdisplay\fP
Specifies the Xvnc server to control.
-
+.
.TP
.B \-nowin
When run as a "helper" app, don't put up a window.
-
+.
.TP
.B \-iconic
When run as a "helper" app, make the window iconified at startup.
change it with this option. The desktop name option is passed to the xstartup
script via the $VNCDESKTOP environment variable, which allows you to run a
different set of applications depending on the name of the desktop.
-
+.
.TP
.B \-geometry \fIwidth\fPx\fIheight\fP
Specify the size of the VNC desktop to be created. Default is 1024x768.
-
+.
.TP
.B \-depth \fIdepth\fP
Specify the pixel depth (in bits) of the VNC desktop to be created. Default is
24. Other possible values are 8, 15 and 16 - anything else is likely to cause
strange behaviour by applications.
-
+.
.TP
.B \-pixelformat \fIformat\fP
Specify pixel format for Xvnc to use (BGRnnn or RGBnnn). The default for
depth 8 is BGR233 (meaning the most significant two bits represent blue, the
next three green, and the least significant three represent red), the default
for depth 16 is RGB565, and the default for depth 24 is RGB888.
-
+.
.TP
.B \-cc 3
As an alternative to the default TrueColor visual, this allows you to run an
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 have an 8-bit depth.
-
+.
.TP
.B \-kill :\fIdisplay#\fP
This kills a VNC desktop previously started with vncserver. It does this by
option ignores anything preceding the first colon (":") in the display
argument. Thus, you can invoke "vncserver \-kill $DISPLAY", for example at the
end of your xstartup file after a particular application exits.
-
+.
.TP
.B \-fp \fIfont-path\fP
If the vncserver script detects that the X Font Server (XFS) is running, it
.B \-fp
argument allows you to override the above fallback logic and specify a font
path for Xvnc to use.
-
+.
.TP
.B \-fg
Runs Xvnc as a foreground process. This has two effects: (1) The VNC server
can be aborted with CTRL-C, and (2) the VNC server will exit as soon as the
user logs out of the window manager in the VNC session. This may be necessary
when launching TigerVNC from within certain grid computing environments.
-
+.
.TP
.B \-autokill
Automatically kill Xvnc whenever the xstartup script exits. In most cases,
this has the effect of terminating Xvnc when the user logs out of the window
manager.
-
+.
.TP
.B \-list
Lists all VNC desktops started by vncserver.
XDamage will be used if the existing X server supports it. Otherwise
.B x0vncserver
will fall back to polling the screen for changes.
+
.SH OPTIONS
.B x0vncserver
interprets the command line as a list of parameters with optional values.
.PP
There are several forms of specifying parameters in the command line (here we
use `\fISomeParameter\fP' as an example parameter name):
+
.TP
.B -\fISomeParameter\fP
Enable the parameter, turn the feature on. This form can be used with
parameters that simply enable or disable some feature.
+.
.TP
.B -\fISomeParameter\fP=0
Disable the parameter, turn the feature off.
+.
.TP
.B -\fISomeParameter\fP=\fIvalue\fP
Assign the specified \fIvalue\fP to the parameter. The leading dash can be
.PP
Parameter names are case-insensitive, their order in the command line can be
arbitrary.
+
.SH PARAMETERS
+
.TP
.B display
The X display name. If not specified, it defaults to the value of the
DISPLAY environment variable.
+.
.TP
.B rfbport
TCP port to listen for incoming VNC connections (RFB protocol). The default
port is 5900.
+.
.TP
.B Log
Specifies which log output should be directed to which target logger, and the
Default is \fB*:stderr:30\fP (log everything to stderr, set log level to 30).
Log level should be a value between 0 and 100, higher levels produce more
output.
+.
.TP
.B HostsFile
This parameter allows to specify a file name with IP access control rules.
\fINetmask\fP is optional and can be specified either in dotted format
(e.g. /255.255.255.0), or as a single number of bits (e.g. /24). Default is
to accept connections from any IP address.
+.
.TP
.B SecurityTypes
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 rfbauth, PasswordFile
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.
+.
.TP
.B Password
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
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
PAM service name to use when authentication users using any of the "Plain"
security types. Default is \fBvnc\fP.
+.
.TP
.B x509cert
Path to a X509 certificate in PEM format to be used for all X509 based
security types (X509None, X509Vnc, etc.).
+.
.TP
.B x509key
Private key counter part to the certificate given in \fBx509cert\fP. Must
also be in PEM format.
+.
.TP
.B BlacklistThreshold
The number of unauthenticated connection attempts allowed from any individual
host before that host is black-listed. Default is 5.
+.
.TP
.B BlacklistTimeout
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 QueryConnect
Prompt the local user to accept or reject incoming connections. Default is
off.
+.
.TP
.B QueryConnectTimeout
Number of seconds to show the Accept Connection dialog before rejecting the
connection. Default is 10.
+.
.TP
.B AlwaysShared
Always treat incoming connections as shared, regardless of the
client-specified setting. Default is off.
+.
.TP
.B NeverShared
Never treat incoming connections as shared, regardless of the
client-specified setting. Default is off.
+.
.TP
.B DisconnectClients
Disconnect existing clients if an incoming connection is non-shared. If
combined with \fBNeverShared\fP then new connections will be refused while
there is a client active. Default is on.
+.
.TP
.B AcceptKeyEvents
Accept key press and release events from clients. Default is on.
+.
.TP
.B AcceptPointerEvents
Accept pointer events from clients. Default is on.
+.
.TP
.B RemapKeys
Comma-separated list of incoming keysyms to remap. Mappings are expressed as
two hex values, prefixed by \fB0x\fP, and separated by \fB->\fP (`dash' and
`greater than' characters).
+.
.TP
.B Protocol3.3
Always use RFB protocol version 3.3 for backwards compatibility with
badly-behaved clients. Default is off.
+.
.TP
.B Geometry
This option specifies the screen area that will be shown to VNC clients. The
right and/or from the bottom of the screen. Offsets are optional, +0+0 is
assumed by default (top left corner). If the argument is empty, full screen
is shown to VNC clients (this is the default).
+.
.TP
.B MaxProcessorUsage
Maximum percentage of CPU time to be consumed when polling the
screen. Default is 35.
+.
.TP
.B PollingCycle
Milliseconds per one polling cycle. Actual interval may be dynamically
adjusted to satisfy \fBMaxProcessorUsage\fP setting. Default is 30.
+.
.TP
.B VideoArea
This option specifies the screen area that will be handled as video. The
clients may choose video selection themselves, but if they do not, then the
\fBVideoArea\fP parameter will take effect. If the argument is empty, no
video area is set (this is the default).
+.
.TP
.B DeferUpdate
x0vncserver uses a "deferred update" mechanism which enhances performance in
single update. Setting it to 0 results in the same behaviour as earlier
versions of x0vncserver, 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 CompareFB
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 UseSHM
Use MIT-SHM extension if available. Using that extension accelerates reading
the screen. Default is on.
+.
.TP
.B OverlayMode
Use overlay mode in IRIX or Solaris (does not have effect in other systems).
This enables system-specific access to complete full-color version of the
screen (the default X visual often provides 256 colors). Also, in overlay
mode, \fBx0vncserver\fP can show correct mouse cursor. 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 IdleTimeout
The number of seconds after which an idle VNC connection will be dropped
(zero means no timeout). Default is 0.
+.
.TP
.B MaxDisconnectionTime
Terminate when no client has been connected for \fIN\fP seconds. Default is
0.
+.
.TP
.B MaxConnectionTime
Terminate when a client has been connected for \fIN\fP seconds. Default is
0.
+.
.TP
.B MaxIdleTime
Terminate after \fIN\fP seconds of user inactivity. Default is 0.
+.
.TP
.B ClientWaitTimeMillis
The number of milliseconds to wait for a client which is no longer
responding. Default is 20000.
+.
.TP
.B AcceptCutText
.TQ
.TQ
.B MaxCutText
Currently unused.
+
.SH SEE ALSO
.BR Xvnc (1),
.BR vncpasswd (1),
.br
http://www.tigervnc.org/
+
.SH AUTHOR
Constantin Kaplinsky and others.
.TP
.B \-geometry \fIwidth\fPx\fIheight\fP
Specify the size of the desktop to be created. Default is 1024x768.
-
+.
.TP
.B \-depth \fIdepth\fP
Specify the pixel depth in bits of the desktop to be created. Default is 24,
other possible values are 8, 15, and 16 - anything else is likely to cause
strange behaviour by applications.
-
+.
.TP
.B \-pixelformat \fIformat\fP
Specify pixel format for server to use (BGRnnn or RGBnnn). The default for
depth 8 is BGR233 (meaning the most significant two bits represent blue, the
next three green, and the least significant three represent red), the default
for depth 16 is RGB565 and for depth 24 is RGB888.
-
+.
.TP
.B \-interface \fIIP address\fP or \-i \fIIP address\fP
Listen on interface. By default Xvnc listens on all available interfaces.
-
+.
.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.
-
+.
.TP
.B \-help
List all the options and parameters
.B \-desktop \fIdesktop-name\fP
Each desktop has a name which may be displayed by the viewer. It defaults to
"x11".
-
+.
.TP
.B \-rfbport \fIport\fP
Specifies the TCP port on which Xvnc listens for connections from viewers (the
protocol used in VNC is called RFB - "remote framebuffer"). The default is
5900 plus the display number.
-
+.
.TP
.B \-rfbwait \fItime\fP, \-ClientWaitTimeMillis \fItime\fP
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).
-
+.
.TP
.B \-httpd \fIdirectory\fP
Run a mini-HTTP server which serves files from the given directory. Normally
with a .vnc extension will have certain substitutions made so that a single
installation of the Java VNC viewer can be served by separate instances of
Xvnc.
-
+.
.TP
.B \-httpPort \fIport\fP
Specifies the port on which the mini-HTTP server runs. Default is 5800 plus
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
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.
-
+.
.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.
-
+.
.TP
.B \-AcceptCutText
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).
-
+.
.TP
.B \-AcceptKeyEvents
Accept key press and release events from clients (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
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).
-
+.
.TP
.B \-AlwaysShared
Always treat incoming connections as shared, regardless of the client-specified
setting (default is off).
-
+.
.TP
.B \-Protocol3.3
Always use protocol version 3.3 for backwards compatibility with badly-behaved
clients (default is off).
-
+.
.TP
.B \-CompareFB
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 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
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
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.
-
+.
.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.
-
+.
.TP
.B \-Log \fIlogname\fP:\fIdest\fP:\fIlevel\fP
Configures the debug log settings. \fIdest\fP can currently be \fBstderr\fP or
output. \fIlogname\fP is usually \fB*\fP meaning all, but you can target a
specific source file if you know the name of its "LogWriter". Default is
\fB*:stderr:30\fP.
-
+.
.TP
.B \-RemapKeys \fImapping
Sets up a keyboard mapping.
is a hexadecimal keysym. For example, to exchange the " and @ symbols you would specify the following:
.IP "" 10
RemapKeys=0x22<>0x40
-
+.
.TP
.B \-AvoidShiftNumLock
Key affected by NumLock often require a fake Shift to be inserted in order
.TP
.B \-display \fIXdisplay\fP
Specifies the X display on which the VNC viewer window should appear.
-
+.
.TP
.B \-geometry \fIgeometry\fP
Standard X position and sizing specification.
-
+.
.TP
.B \-listen \fI[port]\fP
Causes vncviewer to listen on the given port (default 5500) for reverse
using the 'Add New Client' menu option or the '\-connect' command-line option.
Xvnc supports reverse connections with a helper program called
.B vncconfig.
-
+.
.TP
.B \-SecurityTypes \fIsec-types\fP
Specify which security schemes to attempt to use when authenticating with
\fBVncAuth\fP, \fBPlain\fP, \fBTLSNone\fP, \fBTLSVnc\fP, \fBTLSPlain\fP,
\fBX509None\fP, \fBX509Vnc\fP and \fBX509Plain\fP. Default is to attempt
every supported scheme.
-
+.
.TP
.B \-passwd, \-PasswordFile \fIpassword-file\fP
If you are on a filesystem which gives you access to the password file used by
the server, you can specify it here to avoid typing it in. It will usually be
"~/.vnc/passwd".
-
+.
.TP
.B \-Shared
When you make a connection to a VNC server, all other existing connections are
normally closed. This option requests that they be left open, allowing you to
share the desktop with someone already using it.
-
+.
.TP
.B \-ViewOnly
Specifies that no keyboard or mouse events should be sent to the server.
Useful if you want to view a desktop without interfering; often needs to be
combined with
.B \-Shared.
-
+.
.TP
.B \-AcceptClipboard
Accept clipboard changes from the server. Default is on.
-
+.
.TP
.B \-SendClipboard
Send clipboard changes to the server. Default is on.
-
+.
.TP
.B \-SendPrimary
Send the primary selection and cut buffer to the server as well as the
clipboard selection. Default is on.
-
+.
.TP
.B \-Maximize
Maximize viewer window.
-
+.
.TP
.B \-FullScreen
Start in full-screen mode.
-
+.
.TP
.B \-FullScreenAllMonitors
Use all local monitors and not just the current one when switching to
full-screen mode.
-
+.
.TP
.B \-FullscreenSystemKeys
Pass special keys (like Alt+Tab) directly to the server when in full-screen
mode.
-
+.
.TP
.B \-DesktopSize \fIwidth\fPx\fIheight\fP
Instead of keeping the existing remote screen size, the client will attempt to
switch to the specified since when connecting. If the server does not support
the SetDesktopSize message then the screen will retain the original size.
-
+.
.TP
.B \-RemoteResize
Dynamically resize the remote desktop size as the size of the local client
window changes. Note that this may not work with all VNC servers.
-
+.
.TP
.B \-AutoSelect
Use automatic selection of encoding and pixel format (default is on). Normally
the viewer tests the speed of the connection to the server and chooses the
encoding and pixel format appropriately. Turn it off with \fB-AutoSelect=0\fP.
-
+.
.TP
.B \-FullColor, \-FullColour
Tells the VNC server to send full-color pixels in the best format for this
display. This is default.
-
+.
.TP
.B \-LowColorLevel, \-LowColourLevel \fIlevel\fP
Selects the reduced color level to use on slow links. \fIlevel\fP can range
256 colors. Note that decision if reduced color level is used is made by
vncviewer. If you would like to force vncviewer to use reduced color level
use \fB-AutoSelect=0\fP parameter.
-
+.
.TP
.B \-PreferredEncoding \fIencoding\fP
This option specifies the preferred encoding to use from one of "Tight", "ZRLE",
"hextile" or "raw".
-
+.
.TP
.B \-NoJpeg
Disable lossy JPEG compression in Tight encoding. Default is off.
-
+.
.TP
.B \-QualityLevel \fIlevel\fP
JPEG quality level. 0 = Low, 9 = High. May be adjusted automatically if
\fB-AutoSelect\fP is turned on. Default is 8.
-
+.
.TP
.B \-CompressLevel \fIlevel\fP
Use specified lossless compression level. 0 = Low, 6 = High. Default is 2.
-
+.
.TP
.B \-CustomCompressLevel
Use custom compression level. Default if \fBCompressLevel\fP is specified.
-
+.
.TP
.B \-DotWhenNoCursor
Show the dot cursor when the server sends an invisible cursor. Default is off.
-
+.
.TP
.B \-PointerEventInterval \fItime\fP
Time in milliseconds to rate-limit successive pointer events. Default is
to send events immediately.
-
+.
.TP
.B \-Log \fIlogname\fP:\fIdest\fP:\fIlevel\fP
Configures the debug log settings. \fIdest\fP can currently be \fBstderr\fP or
output. \fIlogname\fP is usually \fB*\fP meaning all, but you can target a
specific source file if you know the name of its "LogWriter". Default is
\fB*:stderr:30\fP.
-
+.
.TP
.B \-MenuKey \fIkeysym-name\fP
This option specifies the key which brings up the popup menu. The currently
supported list is: F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, Pause,
Print, Scroll_Lock, Escape, Insert, Delete, Home, Page_Up, Page_Down).
Default is F8.
-
+.
.TP
\fB\-via\fR \fIgateway\fR
Automatically create encrypted TCP tunnel to the \fIgateway\fR machine
projects / tigervnc.git / commitdiff