| Peter Åstrand | 4eacc02 | 2009-02-27 10:12:14 +0000 | [diff] [blame] | 1 | .TH vncconfig 1 "17 Apr 2006" "TigerVNC" "Virtual Network Computing" |
| Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 2 | .SH NAME |
| 3 | vncconfig \- 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 |
| 35 | is used to configure and control a running instance of Xvnc, or any other X |
| 36 | server with the VNC extension. Note that it cannot be used to control VNC |
| 37 | servers prior to version 4. |
| 38 | |
| 39 | When run with no options, it runs as a kind of "helper" application for Xvnc. |
| 40 | Its main purpose when run in this mode is to support clipboard transfer to and |
| 41 | from the VNC viewer(s). Note that without a running instance of |
| 42 | \fBvncconfig\fP there will be no clipboard support. It puts up a window with |
| 43 | some checkboxes which can be used to disable clipboard transfers if required |
| 44 | (in the future there may be more functions available from this window). The |
| 45 | \fB-nowin\fP flag can be used if you always want clipboard support but don't |
| 46 | wish to clutter the desktop with this window - alternatively the \fB-iconic\fP |
| 47 | option can be used to make it iconified by default. |
| 48 | |
| 49 | When run in any other mode, \fBvncconfig\fP is a one-shot program used to |
| 50 | configure or control Xvnc as appropriate. It can be used to tell Xvnc to |
| 51 | connect or disconnect from listening viewers, and to set and retrieve Xvnc's |
| 52 | parameters. |
| 53 | |
| 54 | Note that the DISPLAY environment variable or the \fB\-display\fP option |
| 55 | must be set as appropriate to control Xvnc. If you run it on an ordinary X |
| 56 | server (or on a version 3 Xvnc) you will get an error message saying that there |
| 57 | is no VNC extension. |
| 58 | |
| 59 | .SH OPTIONS |
| 60 | .TP |
| 61 | .B \-connect \fIhost\fP[:\fIport\fP] |
| 62 | Tells an Xvnc server to make a "reverse" connection to a listening VNC viewer |
| 63 | (normally connections are made the other way round - the viewer connects to the |
| 64 | server). \fIhost\fP is the host where the listening viewer is running. If it's |
| 65 | not listening on the default port of 5500, you can specify \fIhost:port\fP |
| 66 | instead. |
| 67 | |
| 68 | .TP |
| 69 | .B \-disconnect |
| 70 | This causes Xvnc to disconnect from all viewers so that the VNC desktop is not |
| 71 | displayed anywhere. |
| 72 | |
| 73 | .TP |
| 74 | [\fB-set\fP] \fIXvnc-param\fP=\fIvalue\fP |
| 75 | Sets an Xvnc parameter to the given value. Note that some of Xvnc's parameters |
| 76 | are read only once at startup so that changing them in this way may not have |
| 77 | any effect. |
| 78 | |
| 79 | .TP |
| 80 | .B \-list |
| 81 | Lists all the parameters supported by Xvnc. |
| 82 | |
| 83 | .TP |
| 84 | .B \-get \fIXvnc-param\fP |
| 85 | Prints the current value of the given Xvnc parameter. |
| 86 | |
| 87 | .TP |
| 88 | .B \-desc \fIXvnc-param\fP |
| 89 | Prints a short description of the given Xvnc parameter. |
| 90 | |
| 91 | .SH PARAMETERS |
| 92 | .B vncconfig |
| 93 | also has parameters of its own which can be set on the command line. These |
| 94 | should not be confused with Xvnc's parameters which are manipulated with the |
| 95 | \fB-set\fP, \fB-get\fP, \fB-list\fP and \fB-desc\fP options. |
| 96 | |
| 97 | Parameters can be turned on with -\fIparam\fP or off with -\fIparam\fP=0. |
| 98 | Parameters which take a value can be specified as -\fIparam\fP \fIvalue\fP. |
| 99 | Other valid forms are \fIparam\fP\fB=\fP\fIvalue\fP -\fIparam\fP=\fIvalue\fP |
| 100 | --\fIparam\fP=\fIvalue\fP. Parameter names are case-insensitive. |
| 101 | |
| 102 | .TP |
| 103 | .B \-display \fIXdisplay\fP |
| 104 | Specifies the Xvnc server to control. |
| 105 | |
| 106 | .TP |
| 107 | .B \-nowin |
| 108 | When run as a "helper" app, don't put up a window. |
| 109 | |
| 110 | .TP |
| 111 | .B \-iconic |
| 112 | When run as a "helper" app, make the window iconified at startup. |
| 113 | |
| 114 | .SH SEE ALSO |
| 115 | .BR vncpasswd (1), |
| 116 | .BR vncviewer (1), |
| 117 | .BR vncserver (1), |
| 118 | .BR Xvnc (1) |
| 119 | .br |
| Peter Åstrand | 4eacc02 | 2009-02-27 10:12:14 +0000 | [diff] [blame] | 120 | http://www.tigervnc.org |
| Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 121 | |
| 122 | .SH AUTHOR |
| Pierre Ossman | e37a144 | 2014-09-17 14:08:16 +0200 | [diff] [blame^] | 123 | Tristan Richardson, RealVNC Ltd. and others. |
| Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 124 | |
| 125 | VNC was originally developed by the RealVNC team while at Olivetti |
| Constantin Kaplinsky | be1bda8 | 2006-06-02 04:43:52 +0000 | [diff] [blame] | 126 | Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were |
| Pierre Ossman | e37a144 | 2014-09-17 14:08:16 +0200 | [diff] [blame^] | 127 | implemented by Constantin Kaplinsky. Many other people have since |
| 128 | participated in development, testing and support. This manual is part |
| 129 | of the TigerVNC software suite. |