Browse Source

Consolidate all README files into one and distribute it with the binary packages.


git-svn-id: svn://svn.code.sf.net/p/tigervnc/code/trunk@4562 3789f03b-4d11-0410-bbf8-ca57d06f2519
tags/v1.1.90
DRC 13 years ago
parent
commit
e72b80501c
6 changed files with 83 additions and 149 deletions
  1. 76
    10
      README.txt
  2. 1
    0
      cmake/BuildPackages.cmake
  3. 0
    15
      release/README.txt
  4. 2
    2
      release/makemacapp.in
  5. 4
    3
      release/tigervnc.iss.in
  6. 0
    119
      win/README_BINARY.txt

+ 76
- 10
README.txt View File

@@ -1,6 +1,25 @@
About TigerVNC
==============

TigerVNC Source Distribution
============================
Virtual Network Computing (VNC) is a remote display system which allows you to
view and interact with a virtual desktop environment that is running on another
computer on the network. Using VNC, you can run graphical applications on a
remote machine and send only the display from these applications to your local
machine. VNC is platform-independent and supports a wide variety of operating
systems and architectures as both servers and clients.

TigerVNC is a high-speed version of VNC based on the RealVNC 4 and X.org code
bases. TigerVNC started as a next-generation development effort for TightVNC
on Unix and Linux platforms, but it split from its parent project in early 2009
so that TightVNC could focus on Windows platforms. TigerVNC supports a variant
of Tight encoding that is greatly accelerated by the use of the libjpeg-turbo
JPEG codec.


Legal
=====

TigerVNC is

Copyright (C) 1999 AT&T Laboratories Cambridge
Copyright (C) 2002-2005 RealVNC Ltd.
@@ -18,15 +37,62 @@ TigerVNC Source Distribution
Copyright (C) 2009-2011 TigerVNC Team
All Rights Reserved.

This software is distributed under the GNU General Public Licence as
published by the Free Software Foundation. See the file LICENCE.TXT
for the conditions under which this software is made available.
TigerVNC also contains code from other sources. See the
Acknowledgements section below, and the individual files for details
of the conditions under which they are made available.
This software is distributed under the GNU General Public Licence as published
by the Free Software Foundation. See the file LICENCE.TXT for the conditions
under which this software is made available. TigerVNC also contains code from
other sources. See the Acknowledgements section below, and the individual
source files, for details of the conditions under which they are made
available.


All Platforms
=============

All versions of TigerVNC contain the following programs:

vncviewer - this is the cross-platform TigerVNC Viewer, written using FLTK.
It connects to a VNC server and allows you to interact with the
remote desktop being displayed by the VNC server. The VNC server
can be running on a Windows or a Unix/Linux machine.


Windows-Specific
================

The Windows version of TigerVNC contains the following programs:

winvnc - the TigerVNC Server for Windows. It allows a Windows desktop to be
accessed remotely using a VNC viewer.

The Windows version of TigerVNC should work on Windows 2000 and later. On
Windows XP and later, winvnc may not work if the Fast User Switching or Remote
Desktop features are in use.


Unix/Linux-Specific (not Mac)
=============================

The Unix/Linux version of TigerVNC contains the following programs:

Xvnc - the TigerVNC Server for Unix. Xvnc is both a VNC server and an X
server with a "virtual" framebuffer. You should normally use the
vncserver script to start Xvnc.

vncserver - a wrapper script which makes starting Xvnc more convenient.
vncserver requires Perl.

vncpasswd - a program which allows you to change the VNC password used to
access your VNC server sessions (assuming that VNC authentication
is being used.) The vncserver script will automatically launch
this program if it detects that VNC authentication is in use and
a VNC password has not yet been configured.

vncconfig - a program which is used to configure and control a running
instance of Xvnc.

For instructions on how to build this software on various platforms, see
BUILDING.txt.
x0vncserver - an inefficient VNC server which continuously polls any X
display, allowing it to be controlled via VNC. It is intended
mainly as a demonstration of a simple VNC server.


ACKNOWLEDGEMENTS

+ 1
- 0
cmake/BuildPackages.cmake View File

@@ -92,3 +92,4 @@ endif() #UNIX
#

install(FILES ${CMAKE_SOURCE_DIR}/LICENCE.TXT DESTINATION doc)
install(FILES ${CMAKE_SOURCE_DIR}/README.txt DESTINATION doc)

+ 0
- 15
release/README.txt View File

@@ -1,15 +0,0 @@
Virtual Network Computing (VNC) is a remote display system which allows you to
view and interact with a virtual desktop environment that is running on another
computer on the network. Using VNC, you can run graphical applications on a
remote machine and send only the display from these applications to your local
machine. VNC is platform-independent and supports a wide variety of operating
systems and architectures as both servers and clients. This package contains a
client which will allow you to connect to a VNC server.

TigerVNC is a high-speed version of VNC based on the RealVNC 4 and X.org code
bases. TigerVNC started as a next-generation development effort for TightVNC
on Unix and Linux platforms, but it split from its parent project in early 2009
so that TightVNC could focus on Windows platforms. TigerVNC supports a variant
of Tight encoding that is greatly accelerated by the use of the libjpeg-turbo
JPEG codec. TigerVNC has replaced RealVNC in the Fedora Project, and there are
long-term plans for it to replace TurboVNC in the VirtualGL Project as well.

+ 2
- 2
release/makemacapp.in View File

@@ -64,8 +64,8 @@ fi
install -m 644 $SRCDIR/release/tigervnc.icns "$APPROOT/Contents/Resources/"
install -m 644 release/Info.plist "$APPROOT/Contents/"

install -m 644 $SRCDIR/LICENCE.txt $TMPDIR/dmg/
install -m 644 $SRCDIR/release/README.txt $TMPDIR/dmg/
install -m 644 $SRCDIR/LICENCE.TXT $TMPDIR/dmg/
install -m 644 $SRCDIR/README.txt $TMPDIR/dmg/

hdiutil create -fs HFS+ -volname $PACKAGE_NAME-$VERSION \
-srcfolder "$TMPDIR/dmg" \

+ 4
- 3
release/tigervnc.iss.in View File

@@ -25,8 +25,8 @@ Source: "@CMAKE_CURRENT_BINARY_DIR@\win\winvnc\{#BUILD_DIR}wm_hooks.dll"; DestDi
Source: "@CMAKE_CURRENT_BINARY_DIR@\win\vncconfig\{#BUILD_DIR}vncconfig.exe"; DestDir: "{app}"; Flags: ignoreversion restartreplace;
#endif
Source: "@CMAKE_CURRENT_BINARY_DIR@\vncviewer\{#BUILD_DIR}vncviewer.exe"; DestDir: "{app}"; Flags: ignoreversion restartreplace;
Source: "@CMAKE_SOURCE_DIR@\win\README_BINARY.txt"; DestDir: "{app}"; Flags: ignoreversion
Source: "@CMAKE_SOURCE_DIR@\LICENCE.txt"; DestDir: "{app}"; Flags: ignoreversion
Source: "@CMAKE_SOURCE_DIR@\README.txt"; DestDir: "{app}"; Flags: ignoreversion
Source: "@CMAKE_SOURCE_DIR@\LICENCE.TXT"; DestDir: "{app}"; Flags: ignoreversion
#ifdef HAVE_GNUTLS
Source: "@GNUTLS_INCLUDE_DIRS@\..\bin\libgnutls-*.dll"; DestDir: "{app}"; Flags: ignoreversion
Source: "@GNUTLS_INCLUDE_DIRS@\..\bin\libgcrypt-*.dll"; DestDir: "{app}"; Flags: ignoreversion
@@ -49,7 +49,8 @@ Name: "{group}\VNC Server (Service-Mode)\Unregister VNC Service"; FileName: "{ap
Name: "{group}\VNC Server (Service-Mode)\Start VNC Service"; FileName: "{app}\winvnc4.exe"; Parameters: "-noconsole -start";
Name: "{group}\VNC Server (Service-Mode)\Stop VNC Service"; FileName: "{app}\winvnc4.exe"; Parameters: "-noconsole -stop";
#endif
Name: "{group}\License"; FileName: "{app}\LICENCE.txt";
Name: "{group}\License"; FileName: "write.exe"; Parameters: "LICENCE.TXT"; WorkingDir: "{app}"; Flags: "useapppaths"
Name: "{group}\Read Me"; FileName: "write.exe"; Parameters: "README.txt"; WorkingDir: "{app}"; Flags: "useapppaths"
Name: "{group}\Uninstall TigerVNC"; FileName: "{uninstallexe}"; WorkingDir: "{app}";

#ifdef BUILD_WINVNC

+ 0
- 119
win/README_BINARY.txt View File

@@ -1,119 +0,0 @@

TigerVNC Binary Distribution for Windows platforms
==================================================

This software is distributed under the GNU General Public Licence as
published by the Free Software Foundation. See the file LICENCE.TXT
for the conditions under which this software is made available.
TigerVNC also contains code from other sources. See the
Acknowledgements section below, and the individual files for details
of the conditions under which they are made available.

The installer package contains two VNC components:

VNC Viewer - this is the VNC Viewer, or client, program for
Windows.
[Win2000, WinXP, and later]

VNC Server - this is the VNC Server for Windows. It allows a
Windows desktop to be accessed remotely using a
VNC Viewer.
[Win2000, WinXP(*), and later]

(*) May not work if the in-built Fast User Switching or Remote
Administration features are in use.


ACKNOWLEDGEMENTS
================

This distribution contains zlib software by Jean-loup Gailly and Mark Adler.
This is:

Copyright (C) 1995-2002 Jean-loup Gailly and Mark Adler.

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.

Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu


The data format used by the zlib library is described by RFCs (Request for
Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
(zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).


This distribution contains public domain DES software by Richard Outerbridge.
This is:

Copyright (c) 1988,1989,1990,1991,1992 by Richard Outerbridge.
(GEnie : OUTER; CIS : [71755,204]) Graven Imagery, 1992.


This distribution contains Java DES software by Dave Zimmerman
<dzimm@widget.com> and Jef Poskanzer <jef@acme.com>. This is:

Copyright (c) 1996 Widget Workshop, Inc. All Rights Reserved.

Permission to use, copy, modify, and distribute this software and its
documentation for NON-COMMERCIAL or COMMERCIAL purposes and without fee
is hereby granted, provided that this copyright notice is kept intact.
WIDGET WORKSHOP MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE
SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WIDGET WORKSHOP SHALL NOT BE
LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING,
MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
THIS SOFTWARE IS NOT DESIGNED OR INTENDED FOR USE OR RESALE AS ON-LINE
CONTROL EQUIPMENT IN HAZARDOUS ENVIRONMENTS REQUIRING FAIL-SAFE
PERFORMANCE, SUCH AS IN THE OPERATION OF NUCLEAR FACILITIES, AIRCRAFT
NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL, DIRECT LIFE
SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH THE FAILURE OF THE
SOFTWARE COULD LEAD DIRECTLY TO DEATH, PERSONAL INJURY, OR SEVERE
PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH RISK ACTIVITIES"). WIDGET
WORKSHOP SPECIFICALLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF
FITNESS FOR HIGH RISK ACTIVITIES.

Copyright (C) 1996 by Jef Poskanzer <jef@acme.com>. All rights
reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Visit the ACME Labs Java page for up-to-date versions of this and other
fine Java utilities: http://www.acme.com/java/


Loading…
Cancel
Save