Update README for version 1.0b2.

Use a standard open source license (two-clause BSD license).
This commit is contained in:
Stephen Heumann 2015-09-24 22:33:24 -05:00
parent a44940a468
commit 50a273440a
2 changed files with 29 additions and 21 deletions

BIN
._README

Binary file not shown.

50
README
View File

@ -1,11 +1,11 @@
VNCview GS 1.0b1 README
VNCview GS 1.0b2 README
VNCview GS is a Virtual Network Computing client (viewer) for the Apple IIgs. You can use it to display and interact with the graphical desktop of another computer through your Apple IIgs.
System Requirements
A (real or emulated) ROM 01 or ROM 3 Apple IIgs
Apple IIgs System Software 6.0.1
Marinetti 2.0 or later, with a functional TCP/IP network connection
Apple IIgs System Software 6.0.1 or later
Marinetti 2.0 or later (latest version recommended)
Andrew Roughan's Crypto Tool Set (needed for password functionality)
A computer running a VNC server to which you have access
Strongly recommended:
@ -13,13 +13,12 @@ An accelerator
A high-bandwidth, low-latency network connection from the IIgs to the server
Marinetti can be downloaded from:
http://www.apple2.org/marinetti/ (stable versions)
http://sourceforge.net/projects/marinetti (development/beta versions)
http://www.apple2.org/marinetti/
The Crypto Tool Set can be downloaded from:
http://home.ozonline.com.au/klajr/apple/crypto.html
http://members.iinet.net.au/~kalandi/apple/crypto.html
VNCview GS will generally perform best when connected to the VNC server through a high-bandwidth, low-latency network connection. A IIgs connected to the network via a high-speed network connection such as a LANceGS and a server connected to your LAN will probably provide the best performance.
VNCview GS will generally perform best when connected to the VNC server through a high-bandwidth, low-latency network connection. A IIgs connected to the network via an Ethernet connection and a server connected to your LAN will probably provide the best performance.
Usage
To start VNCview GS, simply run the "VNCview.GS" program. The New VNC Connection dialog box will be displayed, allowing you to configure and start a VNC connection.
@ -34,9 +33,9 @@ Other options are also available.
"View Only Mode" allows you to see the server's display but not to send any keyboard, mouse, or clipboard input to the server.
"Allow Clipboard Transfers from Server" indicates that the server is allowed to send its clipboard contents, which will be transferred to the IIgs clipboard.
The "Preferred Encoding" is the method that will be used to represent pixels on the server's display when sending them to the IIgs; the available options are Raw and Hextile. The Raw encoding sends lines of pixel values to the IIgs, while Hextile represents the display as a collection of small rectangular areas. One of these methods will likely be faster than the other in your configuration; the best way to tell which is faster for you is to try out both. In general, Raw encoding is best for relatively high-bandwidth connections like Ethernet, while dial-up modems and other low-bandwidth connections may give better performance with the Hextile encoding. Some servers may not support Hextile encoding, in which case Raw will be used regardless of this setting. VNCview GS also supports the "CopyRect" encoding regardless of this setting; it should always be faster than both Raw and Hextile but can only be used in limited circumstances.
The "Preferred Encoding" is the method that will be used to represent pixels on the server's display when sending them to the IIgs; the available options are Raw and Hextile. The Raw encoding sends lines of pixel values to the IIgs, while Hextile represents the display as a collection of small rectangular areas. Raw is generally faster than Hextile in the current version of VNCview GS, but Hextile may be faster on slow network links. Some servers may not support Hextile encoding, in which case Raw will be used regardless of this setting.
When you have configured your new VNC connection, simply click "Connect," and if all goes well you will be connected to the VNC server. You can interact with it with the mouse and keyboard and scroll your view of its display. The option and Open-Apple keys are sent as "alt" and "meta," respectively; their exact interpretation depends on the server. Keyboard shortcuts for menu items are disabled when connected so that these key combinations can be sent to the server. Select "Close" or "Quit" in the File menu when you are done with the connection.
When you have configured your new VNC connection, simply click "Connect," and if all goes well you will be connected to the VNC server. You can interact with it with the mouse and keyboard and scroll your view of its display. The option and Open-Apple keys are sent as "meta" and "alt," respectively; their exact interpretation depends on the server. Keyboard shortcuts for menu items are disabled when connected so that these key combinations can be sent to the server. Select "Close" or "Quit" in the File menu when you are done with the connection.
Menu Items
Apple->About VNCview GS...: Displays information about the program
@ -49,17 +48,22 @@ Edit->Show Clipboard: Displays the current contents of the IIgs clipboard
Edit->Send Clipboard: Transfers the contents of the IIgs clipboard to the server
VNC Server Interoperability
VNCview GS should be able to connect with any VNC server that fully implements the RFB protocol as published by RealVNC Ltd. or its predecessors, though in practice it seems to work better with some servers than with others. Here is a list of some VNC servers for widespread platforms; many others are also available.
VNCview GS should be able to connect with any VNC server that fully implements the RFB protocol as published by RealVNC Ltd. or its predecessors. Here is a list of some VNC servers; many others are also available.
Microsoft Windows & *nix (X11): RealVNC, http://www.realvnc.com/
Mac OS (9 and X): OS9vnc / OSXvnc, http://www.redstonesoftware.com/vnc.html
Microsoft Windows, *nix (X11), and OS X: RealVNC, http://www.realvnc.com/
OS X: Vine Server (OSXvnc), http://www.testplant.com/dlds/vine/
*nix (X11) and OS X: x11vnc, http://www.karlrunge.com/x11vnc/
Troubleshooting
If you are experiencing problems, it may be helpful to try removing, rearranging, or even adding system extensions. This may eliminate assorted problems associated with Marinetti and its interaction with other components of the system. Upgrading to the latest version of Marinetti (3.0b1 as of this writing) may also be helpful.
x11vnc is a good option, because it supports server-side display scaling, which is useful to fit more information on the IIgs screen.
If these steps fail to resolve your problems or if you have other questions, comments, or bug reports, I can be contacted at SHeumann@myrealbox.com.
VNCview GS does not work with the Screen Sharing functionality in OS X, because the Screen Sharing server does not support the pixel format that VNCview GS requires. The above servers can be used instead.
Version History
1.0b2
First open source release
Can display the mouse cursor from the server locally on the IIgs
Mapping of OA and Option keys reversed to match Mac VNC implementations
1.0b1
Faster display updates when using Raw encoding
Servers with screen dimensions smaller that the IIgs screen are now supported.
@ -74,11 +78,15 @@ Bug causing problems with 2nd and subsequent connections fixed
First public release
License
This program, "VNCview GS," is copyright (C) 2002-2004 Stephen Heumann. All rights reserved. This program contains material from the ORCA/C Run-Time Libraries, copyright 1987-1996 by Byte Works, Inc. Used with permission.
Copyright (c) 2002-2015 Stephen Heumann
All rights reserved.
VNCview GS is freeware. Redistribution and use, with or without modification, are permitted provided that the following conditions are met:
1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
2. Altered versions must be plainly marked as such, and must not be misrepresented as being the original software.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "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 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENT 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.
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 COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.
This program contains material from the ORCA/C Run-Time Libraries, copyright 1987-1996 by Byte Works, Inc. Used with permission.