blob: 37465027473eb57833e6021632eaa52ba504c608 [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 Åstrandf8212b92013-06-11 07:06:46 +000037 Copyright (C) 2009-2013 TigerVNC Team
DRC7ac3e152011-06-24 21:24:14 +000038 All Rights Reserved.
39
DRCe72b8052011-06-28 03:02:38 +000040This software is distributed under the GNU General Public Licence as published
41by the Free Software Foundation. See the file LICENCE.TXT for the conditions
42under which this software is made available. TigerVNC also contains code from
43other sources. See the Acknowledgements section below, and the individual
44source files, for details of the conditions under which they are made
45available.
DRC7ac3e152011-06-24 21:24:14 +000046
DRCe72b8052011-06-28 03:02:38 +000047
48All Platforms
49=============
50
51All versions of TigerVNC contain the following programs:
52
DRCd6e54aa2011-06-28 05:05:58 +000053 vncviewer - the cross-platform TigerVNC Viewer, written using FLTK.
54 vncviewer connects to a VNC server and allows you to interact
55 with the remote desktop being displayed by the VNC server. The
56 VNC server can be running on a Windows or a Unix/Linux machine.
DRCe72b8052011-06-28 03:02:38 +000057
58
59Windows-Specific
60================
61
62The Windows version of TigerVNC contains the following programs:
63
DRCd6e54aa2011-06-28 05:05:58 +000064 winvnc - the TigerVNC Server for Windows. winvnc allows a Windows desktop to
65 be accessed remotely using a VNC viewer.
DRCe72b8052011-06-28 03:02:38 +000066
67The Windows version of TigerVNC should work on Windows 2000 and later. On
68Windows XP and later, winvnc may not work if the Fast User Switching or Remote
DRC13884f72012-01-17 11:46:00 +000069Desktop features are in use. Running winvnc as a service does not (yet) work
70with Windows Vista or later.
DRCe72b8052011-06-28 03:02:38 +000071
72
73Unix/Linux-Specific (not Mac)
74=============================
75
76The Unix/Linux version of TigerVNC contains the following programs:
77
78 Xvnc - the TigerVNC Server for Unix. Xvnc is both a VNC server and an X
79 server with a "virtual" framebuffer. You should normally use the
80 vncserver script to start Xvnc.
81
82 vncserver - a wrapper script which makes starting Xvnc more convenient.
83 vncserver requires Perl.
84
85 vncpasswd - a program which allows you to change the VNC password used to
86 access your VNC server sessions (assuming that VNC authentication
87 is being used.) The vncserver script will automatically launch
88 this program if it detects that VNC authentication is in use and
89 a VNC password has not yet been configured.
90
91 vncconfig - a program which is used to configure and control a running
92 instance of Xvnc.
93
94 x0vncserver - an inefficient VNC server which continuously polls any X
95 display, allowing it to be controlled via VNC. It is intended
96 mainly as a demonstration of a simple VNC server.
DRC7ac3e152011-06-24 21:24:14 +000097
98
99ACKNOWLEDGEMENTS
100================
101
102This distribution contains zlib compression software. This is:
103
104 Copyright (C) 1995-2002 Jean-loup Gailly and Mark Adler
105
106 This software is provided 'as-is', without any express or implied
107 warranty. In no event will the authors be held liable for any damages
108 arising from the use of this software.
109
110 Permission is granted to anyone to use this software for any purpose,
111 including commercial applications, and to alter it and redistribute it
112 freely, subject to the following restrictions:
113
114 1. The origin of this software must not be misrepresented; you must not
115 claim that you wrote the original software. If you use this software
116 in a product, an acknowledgment in the product documentation would be
117 appreciated but is not required.
118 2. Altered source versions must be plainly marked as such, and must not be
119 misrepresented as being the original software.
120 3. This notice may not be removed or altered from any source distribution.
121
122 Jean-loup Gailly Mark Adler
123 jloup@gzip.org madler@alumni.caltech.edu
124
125 The data format used by the zlib library is described by RFCs (Request for
126 Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
127 (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
128
129
130This distribution contains public domain DES software by Richard Outerbridge.
131This is:
132
133 Copyright (c) 1988,1989,1990,1991,1992 by Richard Outerbridge.
134 (GEnie : OUTER; CIS : [71755,204]) Graven Imagery, 1992.
135
136
137This distribution contains software from the X Window System. This is:
138
139 Copyright 1987, 1988, 1998 The Open Group
140
141 Permission to use, copy, modify, distribute, and sell this software and its
142 documentation for any purpose is hereby granted without fee, provided that
143 the above copyright notice appear in all copies and that both that
144 copyright notice and this permission notice appear in supporting
145 documentation.
146
147 The above copyright notice and this permission notice shall be included in
148 all copies or substantial portions of the Software.
149
150 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
151 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
152 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
153 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
154 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
155 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
156
157 Except as contained in this notice, the name of The Open Group shall not be
158 used in advertising or otherwise to promote the sale, use or other dealings
159 in this Software without prior written authorization from The Open Group.
160
161
162 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
163
164 All Rights Reserved
165
166 Permission to use, copy, modify, and distribute this software and its
167 documentation for any purpose and without fee is hereby granted,
168 provided that the above copyright notice appear in all copies and that
169 both that copyright notice and this permission notice appear in
170 supporting documentation, and that the name of Digital not be
171 used in advertising or publicity pertaining to distribution of the
172 software without specific, written prior permission.
173
174 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
175 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
176 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
177 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
178 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
179 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
180 SOFTWARE.