blob: 167a9401144dc8f3437482b8a59409cdbbcfbc5e [file] [log] [blame]
DRCe72b8052011-06-28 03:02:38 +00001About TigerVNC
2==============
DRC7ac3e152011-06-24 21:24:14 +00003
DRCe72b8052011-06-28 03:02:38 +00004Virtual Network Computing (VNC) is a remote display system which allows you to
5view and interact with a virtual desktop environment that is running on another
6computer on the network. Using VNC, you can run graphical applications on a
7remote machine and send only the display from these applications to your local
8machine. VNC is platform-independent and supports a wide variety of operating
9systems and architectures as both servers and clients.
10
11TigerVNC is a high-speed version of VNC based on the RealVNC 4 and X.org code
12bases. TigerVNC started as a next-generation development effort for TightVNC
13on Unix and Linux platforms, but it split from its parent project in early 2009
14so that TightVNC could focus on Windows platforms. TigerVNC supports a variant
15of Tight encoding that is greatly accelerated by the use of the libjpeg-turbo
16JPEG codec.
17
18
19Legal
20=====
21
Pierre Ossmanb27264f2014-03-19 13:35:14 +000022Incomplete and generally out of date copyright list:
DRC7ac3e152011-06-24 21:24:14 +000023
24 Copyright (C) 1999 AT&T Laboratories Cambridge
25 Copyright (C) 2002-2005 RealVNC Ltd.
26 Copyright (C) 2000-2006 TightVNC Group
27 Copyright (C) 2005-2006 Martin Koegler
28 Copyright (C) 2005-2006 Sun Microsystems, Inc.
29 Copyright (C) 2006 OCCAM Financial Technology
30 Copyright (C) 2000-2008 Constantin Kaplinsky
31 Copyright (C) 2004-2009 Peter Astrand for Cendio AB
32 Copyright (C) 2010 Antoine Martin
33 Copyright (C) 2010 m-privacy GmbH
34 Copyright (C) 2009-2011 D. R. Commander
35 Copyright (C) 2009-2011 Pierre Ossman for Cendio AB
36 Copyright (C) 2004, 2009-2011 Red Hat, Inc.
Peter Åstrand (astrand)3a1db162017-10-16 11:11:45 +020037 Copyright (C) 2017 Peter Astrand for Cendio AB
Samuel Mannehed8e5a29e2017-03-20 13:07:30 +010038 Copyright (C) 2009-2017 TigerVNC Team
DRC7ac3e152011-06-24 21:24:14 +000039 All Rights Reserved.
40
DRCe72b8052011-06-28 03:02:38 +000041This software is distributed under the GNU General Public Licence as published
42by the Free Software Foundation. See the file LICENCE.TXT for the conditions
43under which this software is made available. TigerVNC also contains code from
44other sources. See the Acknowledgements section below, and the individual
45source files, for details of the conditions under which they are made
46available.
DRC7ac3e152011-06-24 21:24:14 +000047
DRCe72b8052011-06-28 03:02:38 +000048
49All Platforms
50=============
51
52All versions of TigerVNC contain the following programs:
53
DRCd6e54aa2011-06-28 05:05:58 +000054 vncviewer - the cross-platform TigerVNC Viewer, written using FLTK.
55 vncviewer connects to a VNC server and allows you to interact
56 with the remote desktop being displayed by the VNC server. The
57 VNC server can be running on a Windows or a Unix/Linux machine.
DRCe72b8052011-06-28 03:02:38 +000058
59
60Windows-Specific
61================
62
63The Windows version of TigerVNC contains the following programs:
64
DRCd6e54aa2011-06-28 05:05:58 +000065 winvnc - the TigerVNC Server for Windows. winvnc allows a Windows desktop to
66 be accessed remotely using a VNC viewer.
DRCe72b8052011-06-28 03:02:38 +000067
Pierre Ossman610b4012017-03-07 12:47:03 +010068winvnc may not work if the Fast User Switching or Remote Desktop features are
69in use.
DRCe72b8052011-06-28 03:02:38 +000070
71
72Unix/Linux-Specific (not Mac)
73=============================
74
75The Unix/Linux version of TigerVNC contains the following programs:
76
77 Xvnc - the TigerVNC Server for Unix. Xvnc is both a VNC server and an X
78 server with a "virtual" framebuffer. You should normally use the
79 vncserver script to start Xvnc.
80
81 vncserver - a wrapper script which makes starting Xvnc more convenient.
82 vncserver requires Perl.
83
84 vncpasswd - a program which allows you to change the VNC password used to
85 access your VNC server sessions (assuming that VNC authentication
86 is being used.) The vncserver script will automatically launch
87 this program if it detects that VNC authentication is in use and
88 a VNC password has not yet been configured.
89
90 vncconfig - a program which is used to configure and control a running
91 instance of Xvnc.
92
93 x0vncserver - an inefficient VNC server which continuously polls any X
94 display, allowing it to be controlled via VNC. It is intended
95 mainly as a demonstration of a simple VNC server.
DRC7ac3e152011-06-24 21:24:14 +000096
97
98ACKNOWLEDGEMENTS
99================
100
101This distribution contains zlib compression software. This is:
102
103 Copyright (C) 1995-2002 Jean-loup Gailly and Mark Adler
104
105 This software is provided 'as-is', without any express or implied
106 warranty. In no event will the authors be held liable for any damages
107 arising from the use of this software.
108
109 Permission is granted to anyone to use this software for any purpose,
110 including commercial applications, and to alter it and redistribute it
111 freely, subject to the following restrictions:
112
113 1. The origin of this software must not be misrepresented; you must not
114 claim that you wrote the original software. If you use this software
115 in a product, an acknowledgment in the product documentation would be
116 appreciated but is not required.
117 2. Altered source versions must be plainly marked as such, and must not be
118 misrepresented as being the original software.
119 3. This notice may not be removed or altered from any source distribution.
120
121 Jean-loup Gailly Mark Adler
122 jloup@gzip.org madler@alumni.caltech.edu
123
124 The data format used by the zlib library is described by RFCs (Request for
125 Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
126 (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
127
128
129This distribution contains public domain DES software by Richard Outerbridge.
130This is:
131
132 Copyright (c) 1988,1989,1990,1991,1992 by Richard Outerbridge.
133 (GEnie : OUTER; CIS : [71755,204]) Graven Imagery, 1992.
134
135
136This distribution contains software from the X Window System. This is:
137
138 Copyright 1987, 1988, 1998 The Open Group
139
140 Permission to use, copy, modify, distribute, and sell this software and its
141 documentation for any purpose is hereby granted without fee, provided that
142 the above copyright notice appear in all copies and that both that
143 copyright notice and this permission notice appear in supporting
144 documentation.
145
146 The above copyright notice and this permission notice shall be included in
147 all copies or substantial portions of the Software.
148
149 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
150 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
151 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
152 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
153 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
154 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
155
156 Except as contained in this notice, the name of The Open Group shall not be
157 used in advertising or otherwise to promote the sale, use or other dealings
158 in this Software without prior written authorization from The Open Group.
159
160
161 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
162
163 All Rights Reserved
164
165 Permission to use, copy, modify, and distribute this software and its
166 documentation for any purpose and without fee is hereby granted,
167 provided that the above copyright notice appear in all copies and that
168 both that copyright notice and this permission notice appear in
169 supporting documentation, and that the name of Digital not be
170 used in advertising or publicity pertaining to distribution of the
171 software without specific, written prior permission.
172
173 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
174 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
175 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
176 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
177 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
178 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
179 SOFTWARE.