1vncconfig(1)               Virtual Network Computing              vncconfig(1)
2
3
4

NAME

6       vncconfig - configure and control a VNC server
7

SYNOPSIS

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

DESCRIPTION

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
22       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 query the user  how
24       new  connections  should be handled (provided this feature is enabled).
25       The -nowin flag can be used if you always want the  query  support  but
26       don't  wish  to clutter the desktop with the settings window - alterna‐
27       tively the -iconic option can be used to make it iconified by default.
28
29       When run in any other mode, vncconfig is a  one-shot  program  used  to
30       configure  or control Xvnc as appropriate.  It can be used to tell Xvnc
31       to connect or  disconnect  from  listening  viewers,  and  to  set  and
32       retrieve Xvnc's parameters.
33
34       Note  that the DISPLAY environment variable or the -display option must
35       be set as appropriate to control Xvnc.  If you run it on an ordinary  X
36       server  (or  on  a version 3 Xvnc) you will get an error message saying
37       that there is no VNC extension.
38
39

OPTIONS

41       -connect host[:port]
42              Tells an Xvnc server to make a "reverse" connection to a listen‐
43              ing  VNC  viewer  (normally  connections  are made the other way
44              round - the viewer connects to the server).  host  is  the  host
45              where  the listening viewer is running. If it's not listening on
46              the default port of 5500, you can specify host:port instead.
47
48       -disconnect
49              This causes Xvnc to disconnect from all viewers so that the  VNC
50              desktop is not displayed anywhere.
51
52       [-set] Xvnc-param=value
53              Sets  an  Xvnc  parameter to the given value.  Note that some of
54              Xvnc's parameters are read only once at startup so that changing
55              them in this way may not have any effect.
56
57       -list  Lists all the parameters supported by Xvnc.
58
59       -get Xvnc-param
60              Prints the current value of the given Xvnc parameter.
61
62       -desc Xvnc-param
63              Prints a short description of the given Xvnc parameter.
64
65

PARAMETERS

67       vncconfig  also  has parameters of its own which can be set on the com‐
68       mand line.  These should not be confused with Xvnc's  parameters  which
69       are manipulated with the -set, -get, -list and -desc options.
70
71       Parameters  can be turned on with -param or off with -param=0.  Parame‐
72       ters which take a value can be specified as -param value.  Other  valid
73       forms  are param=value -param=value --param=value.  Parameter names are
74       case-insensitive.
75
76
77       -display Xdisplay
78              Specifies the Xvnc server to control.
79
80       -nowin When run as a "helper" app, don't put up a window.
81
82       -iconic
83              When run as  a  "helper"  app,  make  the  window  iconified  at
84              startup.
85
86

SEE ALSO

88       vncpasswd(1), vncviewer(1), vncserver(1), Xvnc(1)
89       https://www.tigervnc.org
90
91

AUTHOR

93       Tristan Richardson, RealVNC Ltd. and others.
94
95       VNC  was  originally  developed  by  the RealVNC team while at Olivetti
96       Research Ltd / AT&T Laboratories Cambridge.   TightVNC  additions  were
97       implemented  by Constantin Kaplinsky. Many other people have since par‐
98       ticipated in development, testing and support. This manual is  part  of
99       the TigerVNC software suite.
100
101
102
103TigerVNC                                                          vncconfig(1)
Impressum