Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_tigervnc / refs/heads/android-16 / . / unix / vncconfig / vncconfig.man
blob: b685a4660f148f4c90217df827717aca8ac4ef5d [file] [log] [blame]
Pierre Ossmanf256a1a2014-09-17 14:09:58 +0200[diff] [blame]1.TH vncconfig 1 "" "TigerVNC" "Virtual Network Computing"
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]2.SH NAME
3vncconfig \- configure and control a VNC server
4.SH SYNOPSIS
5.B vncconfig
6.RI [ parameters ]
7.br
8.B vncconfig
9.RI [ parameters ]
10.B \-connect
11.IR host [: port ]
12.br
13.B vncconfig
14.RI [ parameters ]
15.B \-disconnect
16.br
17.B vncconfig
18.RI [ parameters ]
19.RB [ -set ]
20.IR Xvnc-param = value " ..."
21.br
22.B vncconfig
23.RI [ parameters ]
24.B \-list
25.br
26.B vncconfig
27.RI [ parameters ]
28\fB\-get\fP \fIXvnc-param\fP
29.br
30.B vncconfig
31.RI [ parameters ]
32\fB\-desc\fP \fIXvnc-param\fP
33.SH DESCRIPTION
34.B vncconfig
35is used to configure and control a running instance of Xvnc, or any other X
36server with the VNC extension. Note that it cannot be used to control VNC
37servers prior to version 4.
38
39When run with no options, it runs as a kind of "helper" application for Xvnc.
Pierre Ossmanbfd567a2016-01-12 18:57:37 +0100[diff] [blame]40Its main purpose when run in this mode is to query the user how new
41connections should be handled (provided this feature is enabled). The
42\fB-nowin\fP flag can be used if you always want the query support but don't
43wish to clutter the desktop with the settings window - alternatively the
44\fB-iconic\fP option can be used to make it iconified by default.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]45
46When run in any other mode, \fBvncconfig\fP is a one-shot program used to
47configure or control Xvnc as appropriate. It can be used to tell Xvnc to
48connect or disconnect from listening viewers, and to set and retrieve Xvnc's
49parameters.
50
51Note that the DISPLAY environment variable or the \fB\-display\fP option
52must be set as appropriate to control Xvnc. If you run it on an ordinary X
53server (or on a version 3 Xvnc) you will get an error message saying that there
54is no VNC extension.
55
56.SH OPTIONS
57.TP
58.B \-connect \fIhost\fP[:\fIport\fP]
59Tells an Xvnc server to make a "reverse" connection to a listening VNC viewer
60(normally connections are made the other way round - the viewer connects to the
61server). \fIhost\fP is the host where the listening viewer is running. If it's
62not listening on the default port of 5500, you can specify \fIhost:port\fP
63instead.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]64.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]65.TP
66.B \-disconnect
67This causes Xvnc to disconnect from all viewers so that the VNC desktop is not
68displayed anywhere.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]69.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]70.TP
71[\fB-set\fP] \fIXvnc-param\fP=\fIvalue\fP
72Sets an Xvnc parameter to the given value. Note that some of Xvnc's parameters
73are read only once at startup so that changing them in this way may not have
74any effect.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]75.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]76.TP
77.B \-list
78Lists all the parameters supported by Xvnc.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]79.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]80.TP
81.B \-get \fIXvnc-param\fP
82Prints the current value of the given Xvnc parameter.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]83.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]84.TP
85.B \-desc \fIXvnc-param\fP
86Prints a short description of the given Xvnc parameter.
87
88.SH PARAMETERS
89.B vncconfig
90also has parameters of its own which can be set on the command line. These
91should not be confused with Xvnc's parameters which are manipulated with the
92\fB-set\fP, \fB-get\fP, \fB-list\fP and \fB-desc\fP options.
93
94Parameters can be turned on with -\fIparam\fP or off with -\fIparam\fP=0.
95Parameters which take a value can be specified as -\fIparam\fP \fIvalue\fP.
96Other valid forms are \fIparam\fP\fB=\fP\fIvalue\fP -\fIparam\fP=\fIvalue\fP
97--\fIparam\fP=\fIvalue\fP. Parameter names are case-insensitive.
98
99.TP
100.B \-display \fIXdisplay\fP
101Specifies the Xvnc server to control.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]102.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]103.TP
104.B \-nowin
105When run as a "helper" app, don't put up a window.
Pierre Ossman23f67c32014-09-17 16:28:56 +0200[diff] [blame]106.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]107.TP
108.B \-iconic
109When run as a "helper" app, make the window iconified at startup.
110
111.SH SEE ALSO
112.BR vncpasswd (1),
113.BR vncviewer (1),
114.BR vncserver (1),
115.BR Xvnc (1)
116.br
Pierre Ossman32b96ff2018-10-19 14:56:53 +0200[diff] [blame]117https://www.tigervnc.org
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]118
119.SH AUTHOR
Pierre Ossmane37a1442014-09-17 14:08:16 +0200[diff] [blame]120Tristan Richardson, RealVNC Ltd. and others.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]121
122VNC was originally developed by the RealVNC team while at Olivetti
Constantin Kaplinskybe1bda82006-06-02 04:43:52 +0000[diff] [blame]123Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
Pierre Ossmane37a1442014-09-17 14:08:16 +0200[diff] [blame]124implemented by Constantin Kaplinsky. Many other people have since
125participated in development, testing and support. This manual is part
126of the TigerVNC software suite.