MAN page from OpenSuSE xorg-x11-Xvnc-1.9.0-lp18.104.22.168.x86_64.rpm
Section: TigerVNC Manual (1)
x0vncserver - TigerVNC Server for X displays
is a TigerVNC Server which makes any X display remotely accessible via VNC,TigerVNC or compatible viewers. Unlike Xvnc
(1), it does not create avirtual display. Instead, it just shares an existing X server (typically,that one connected to the physical screen).
XDamage will be used if the existing X server supports it. Otherwisex0vncserverwill fall back to polling the screen for changes.
interprets the command line as a list of parameters with optional values.Running x0vncserver -h
will show a list of all valid parameters withshort descriptions. All parameters are optional, but normally you would haveto use the PasswordFile
parameter (see its description below).
There are several forms of specifying parameters in the command line (here weuse `SomeParameter' as an example parameter name):
- Enable the parameter, turn the feature on. This form can be used withparameters that simply enable or disable some feature.
- Disable the parameter, turn the feature off.
- Assign the specified value to the parameter. The leading dash can beomitted, or it can be doubled if desired (like in GNU-style long options).
Parameter names are case-insensitive, their order in the command line can bearbitrary.
- -display display
- The X display name. If not specified, it defaults to the value of theDISPLAY environment variable.
- -rfbport port
- Specifies the TCP port on which x0vncserver listens for connections fromviewers (the protocol used in VNC is called RFB - "remote framebuffer").The default port is 5900.
- Use IPv4 for incoming and outgoing connections. Default is on.
- Use IPv6 for incoming and outgoing connections. Default is on.
- -rfbunixpath path
- Specifies the path of a Unix domain socket on which x0vncserver listens forconnections from viewers, instead of listening on a TCP port.
- -rfbunixmode mode
- Specifies the mode of the Unix domain socket. The default is 0600.
- -Log logname:dest:level
- Configures the debug log settings. dest can currently be stderr,stdout or syslog, and level is between 0 and 100, 100 meaningmost verbose output. logname is usually * meaning all, but you cantarget a specific source file if you know the name of its "LogWriter". Defaultis *:stderr:30.
- -HostsFile filename
- This parameter allows to specify a file name with IP access control rules.The file should include one rule per line, and the rule format is one of thefollowing: +address/prefix (accept connections from thespecified address group), -address/prefix (reject connections)or ?address/prefix (query the local user). The first rulematching the IP address determines the action to be performed. Rules thatinclude only an action sign (+, - or ?) will match any IP address.Prefix is optional and is specified as a number of bits (e.g. /24).Default is to accept connections from any IP address.
- -SecurityTypes sec-types
- Specify which security scheme to use for incoming connections. Valid valuesare a comma separated list of None, VncAuth, Plain,TLSNone, TLSVnc, TLSPlain, X509None, X509Vncand X509Plain. Default is VncAuth,TLSVnc.
- -rfbauth passwd-file, -PasswordFile passwd-file
- Password file for VNC authentication. There is no default, you shouldspecify the password file explicitly. Password file should be created withthe vncpasswd(1) utility. The file is accessed each time a connectioncomes in, so it can be changed on the fly.
- -Password password
- Obfuscated binary encoding of the password which clients must supply toaccess the server. Using this parameter is insecure, use PasswordFileparameter instead.
- -PlainUsers user-list
- A comma separated list of user names that are allowed to authenticate viaany of the "Plain" security types (Plain, TLSPlain, etc.). Specify *to allow any user to authenticate using this security type. Default is todeny all users.
- -pam_service name, -PAMService name
- PAM service name to use when authentication users using any of the "Plain"security types. Default is vnc.
- -X509Cert path
- Path to a X509 certificate in PEM format to be used for all X509 basedsecurity types (X509None, X509Vnc, etc.).
- -X509Key path
- Private key counter part to the certificate given in X509Cert. Mustalso be in PEM format.
- -GnuTLSPriority priority
- GnuTLS priority string that controls the TLS session’s handshake algorithms.See the GnuTLS manual for possible values. Default is NORMAL.
- -BlacklistThreshold count
- The number of unauthenticated connection attempts allowed from any individualhost before that host is black-listed. Default is 5.
- -BlacklistTimeout seconds
- The initial timeout applied when a host is first black-listed. The hostcannot re-attempt a connection until the timeout expires. Default is 10.
- Prompts the user of the desktop to explicitly accept or reject incomingconnections. Default is off.
- -QueryConnectTimeout seconds
- Number of seconds to show the Accept Connection dialog before rejecting theconnection. Default is 10.
- Always treat incoming connections as shared, regardless of the client-specifiedsetting. Default is off.
- Never treat incoming connections as shared, regardless of the client-specifiedsetting. Default is off.
- Disconnect existing clients if an incoming connection is non-shared. Default ison. If DisconnectClients is false, then a new non-shared connection willbe refused while there is a client active. When combined withNeverShared this means only one client is allowed at a time.
- Accept key press and release events from clients. Default is on.
- Accept pointer press and release events from clients. Default is on.
- -RemapKeys mapping
- Sets up a keyboard mapping.mappingis a comma-separated string of character mappings, each of the formchar->char,orchar<>char,wherecharis a hexadecimal keysym. For example, to exchange the " and @ symbols you would specify the following:
- Send keyboard events straight through and avoid mapping them to the currentkeyboard layout. This effectively makes the keyboard behave according to thelayout configured on the server instead of the layout configured on theclient. Default is off.
- Always use protocol version 3.3 for backwards compatibility with badly-behavedclients. Default is off.
- -Geometry geometry
- This option specifies the screen area that will be shown to VNC clients. Theformat iswidthxheight+xoffset+yoffset, where `+' signs can be replaced with `-' signs to specify offsets from theright and/or from the bottom of the screen. Offsets are optional, +0+0 isassumed by default (top left corner). If the argument is empty, full screenis shown to VNC clients (this is the default).
- -MaxProcessorUsage percent
- Maximum percentage of CPU time to be consumed when polling thescreen. Default is 35.
- -PollingCycle milliseconds
- Milliseconds per one polling cycle. Actual interval may be dynamicallyadjusted to satisfy MaxProcessorUsage setting. Default is 30.
- -FrameRate fps
- The maximum number of updates per second sent to each client. If the screenupdates any faster then those changes will be aggregated and sent in a singleupdate to the client. Note that this only controls the maximum rate and aclient may get a lower rate when resources are limited. Default is 60.
- -CompareFB mode
- Perform pixel comparison on framebuffer to reduce unnecessary updates. Canbe either 0 (off), 1 (always) or 2 (auto). Default is2.
- Use MIT-SHM extension if available. Using that extension accelerates readingthe screen. Default is on.
- -ZlibLevel level
- Zlib compression level for ZRLE encoding (it does not affect Tight encoding).Acceptable values are between 0 and 9. Default is to use the standardcompression level provided by the zlib(3) compression library.
- Use improved compression algorithm for Hextile encoding which achieves bettercompression ratios by the cost of using slightly more CPU time. Default ison.
- -IdleTimeout seconds
- 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.
- -MaxDisconnectionTime seconds
- Terminate when no client has been connected for N seconds. Default is0.
- -MaxConnectionTime seconds
- Terminate when a client has been connected for N seconds. Default is0.
- -MaxIdleTime seconds
- Terminate after N seconds of user inactivity. Default is 0.
- -ClientWaitTimeMillis time
- Time in milliseconds to wait for a viewer which is blocking the server. This isnecessary because the server is single-threaded and sometimes blocks until theviewer has finished sending or receiving a message - note that this does notmean an update will be aborted after this time. Default is 20000 (20 seconds).
- -SendCutText-MaxCutTextCurrently unused.
Constantin Kaplinsky and others.
VNC was originally developed by the RealVNC team while at OlivettiResearch Ltd / AT&T Laboratories Cambridge. TightVNC additions wereimplemented by Constantin Kaplinsky. Many other people have sinceparticipated in development, testing and support. This manual is partof the TigerVNC software suite.
- SEE ALSO
This document was created byman2html,using the manual pages.