vncconfig - configure and control a VNC server
is used to configure and control a running instance of Xvnc, or any
other X server with the VNC extension. Note that it cannot be used to
control VNC servers prior to version 4. It can be run either in
interactive mode or in command-line mode.
With no arguments, the
command launches a graphical front-end to the VNC server. Its main
purpose when run in this mode is to support clipboard transfer to and
from the VNC viewer(s). Note that, without an instance of
vncconfig running in interactive mode, there will be no
clipboard support. However, see below for
details of the -nowin command-line option.
- Accept clipboard from viewers
If checked, clipboard text received from VNC viewers will be put on
the clipboard of the X server.
- Send clipboard to viewers
If checked, text copied to the clipboard of the X server will be sent
to VNC viewers.
- Send primary selection to viewers
If checked, whenever the primary selection changes, it will be sent to
- Enable guest login
If checked, users will be able to connect using the guest login name
(usually "guest") and password (usually none). See the Xvnc man page
for information regarding the
GuestAccess, GuestUserName, GuestPassword and GuestPasswordFile
This button is used to download or upload files to or from the VNC
server. Click the Share files... menu item to specify a file or
directory to make available to VNC viewers. Click the
Fetch files... menu item to download the files currently available.
This button displays a list of active connections from which you can
disconnect individual clients or change their level of access.
Two command-line options are available in interactive mode:
Do not display the vncconfig window. This is useful you want
clipboard support but don't wish to clutter the desktop.
Make the vncconfig window iconified by default.
When run with any other command-line options, vncconfig is a
one-shot program used to configure or control Xvnc as appropriate. It
can be used to tell Xvnc to connect or disconnect from listening
viewers, and to set and retrieve Xvnc's parameters.
Note that the DISPLAY environment variable or the -display option
must be set as appropriate to control Xvnc. If you run it on an ordinary X
server (or on a version 3 Xvnc) you will get an error message saying that there
is no VNC extension.
- -connect host[:port]
Tells an Xvnc server to make a "reverse" connection to a listening VNC viewer
(normally connections are made the other way round - the viewer connects to the
server). host is the host where the listening viewer is running. If it's
not listening on the default port of 5500, you can specify host:port
This causes Xvnc to disconnect from all viewers so that the VNC desktop is not
- [-set] Xvnc-param=value
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
Lists all the parameters supported by Xvnc.
Lists the current connections to the VNC desktop.
- -get Xvnc-param
Prints the current value of the given Xvnc parameter.
- -desc Xvnc-param
Prints a short description of the given Xvnc parameter.
also has parameters of its own which can be set on the command line. These
should not be confused with Xvnc's parameters which are manipulated with the
-set, -get, -list and -desc options.
Parameters can be turned on with -param or off with -param=0.
Parameters which take a value can be specified as -param value.
Other valid forms are param=value -param=value
--param=value. Parameter names are case-insensitive.
- -display Xdisplay
Specifies the Xvnc server to control.
When run in interactive mode, don't put up a window.
When run in interactive mode, make the window iconified at startup.
- -poll millis
Some badly-behaved X applications change the contents of the clipboard without
notifying the rest of the system. To cope with these applications, vncconfig
can be made to check the contents of the clipboard every millis
milliseconds to see if it has changed.