1vncconfig(1) Virtual Network Computing vncconfig(1)
2
6 vncconfig - configure and control a VNC server
7
9 vncconfig [parameters]
10 vncconfig [parameters] -connect host[:port]
11 vncconfig [parameters] -disconnect
12 vncconfig [parameters] [-set] Xvnc-param=value ...
13 vncconfig [parameters] -list
14 vncconfig [parameters] -get Xvnc-param
15 vncconfig [parameters] -desc Xvnc-param
16
18 vncconfig is used to configure and control a running instance of Xvnc,
19 or any other X server with the VNC extension. Note that it cannot be
20 used to control VNC servers prior to version 4.
21 When run with no options, it runs as a kind of "helper" application for
23 Xvnc. Its main purpose when run in this mode is to support clipboard
24 transfer to and from the VNC viewer(s). Note that without a running
25 instance of vncconfig there will be no clipboard support. It puts up a
26 window with some checkboxes which can be used to disable clipboard
27 transfers if required (in the future there may be more functions avail‐
28 able from this window). The -nowin flag can be used if you always want
29 clipboard support but don't wish to clutter the desktop with this win‐
30 dow - alternatively the -iconic option can be used to make it iconified
31 by default.
32 When run in any other mode, vncconfig is a one-shot program used to
34 configure or control Xvnc as appropriate. It can be used to tell Xvnc
35 to connect or disconnect from listening viewers, and to set and
36 retrieve Xvnc's parameters.
37 Note that the DISPLAY environment variable or the -display option must
39 be set as appropriate to control Xvnc. If you run it on an ordinary X
40 server (or on a version 3 Xvnc) you will get an error message saying
41 that there is no VNC extension.
42
45 -connect host[:port]
46 Tells an Xvnc server to make a "reverse" connection to a listen‐
47 ing VNC viewer (normally connections are made the other way
48 round - the viewer connects to the server). host is the host
49 where the listening viewer is running. If it's not listening on
50 the default port of 5500, you can specify host:port instead.
51 -disconnect
54 This causes Xvnc to disconnect from all viewers so that the VNC
55 desktop is not displayed anywhere.
56 [-set] Xvnc-param=value
59 Sets an Xvnc parameter to the given value. Note that some of
60 Xvnc's parameters are read only once at startup so that changing
61 them in this way may not have any effect.
62 -list Lists all the parameters supported by Xvnc.
65 -get Xvnc-param
68 Prints the current value of the given Xvnc parameter.
69 -desc Xvnc-param
72 Prints a short description of the given Xvnc parameter.
73
76 vncconfig also has parameters of its own which can be set on the com‐
77 mand line. These should not be confused with Xvnc's parameters which
78 are manipulated with the -set, -get, -list and -desc options.
79 Parameters can be turned on with -param or off with -param=0. Parame‐
81 ters which take a value can be specified as -param value. Other valid
82 forms are param=value -param=value --param=value. Parameter names are
83 case-insensitive.
84 -display Xdisplay
87 Specifies the Xvnc server to control.
88 -nowin When run as a "helper" app, don't put up a window.
91 -iconic
94 When run as a "helper" app, make the window iconified at
95 startup.
96
99 vncpasswd(1), vncviewer(1), vncserver(1), Xvnc(1)
100 http://www.tigervnc.org
101
104 Tristan Richardson, RealVNC Ltd.
105 VNC was originally developed by the RealVNC team while at Olivetti
107 Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
108 implemented by Constantin Kaplinsky. Many other people participated in
109 development, testing and support.
110TigerVNC 17 Apr 2006 vncconfig(1)