Update README

This commit is contained in:
Stephen Heumann 2016-09-05 22:56:55 -05:00
parent 462b351425
commit 0bf868147c
3 changed files with 27 additions and 9 deletions

BIN
._README

Binary file not shown.

19
README
View File

@ -5,7 +5,7 @@ VNCview GS is a Virtual Network Computing client (viewer) for the Apple IIgs. Y
System Requirements System Requirements
A (real or emulated) ROM 01 or ROM 3 Apple IIgs A (real or emulated) ROM 01 or ROM 3 Apple IIgs
Apple IIgs System Software 6.0.1 or later Apple IIgs System Software 6.0.1 or later
Marinetti 2.0 or later (latest version recommended) Marinetti (latest version recommended)
Andrew Roughan's Crypto Tool Set (needed for password functionality) Andrew Roughan's Crypto Tool Set (needed for password functionality)
A computer running a VNC server to which you have access A computer running a VNC server to which you have access
Strongly recommended: Strongly recommended:
@ -18,7 +18,9 @@ http://www.apple2.org/marinetti/
The Crypto Tool Set can be downloaded from: The Crypto Tool Set can be downloaded from:
http://members.iinet.net.au/~kalandi/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 an Ethernet connection and a server connected to your LAN will probably provide the best performance. A IIgs connected to the network via an Ethernet connection and a server connected to your LAN will probably provide the best performance.
Under Sweet16, there is a known issue where the networking code within Sweet16 may drop the connection to the VNC server. This generally occurs at relatively low emulated speeds; you can usually avoid it by using high or unlimited speed.
Usage 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. 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.
@ -33,7 +35,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. "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. "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. 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. 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 very slow network links. Some servers may not support Hextile encoding, in which case Raw will be used regardless of this setting.
The "Tune Marinetti for high throughput" option configures Marinetti to process a larger amount of incoming data at once than it does by default. This generally improves performance.
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. 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.
@ -48,7 +52,7 @@ Edit->Show Clipboard: Displays the current contents of the IIgs clipboard
Edit->Send Clipboard: Transfers the contents of the IIgs clipboard to the server Edit->Send Clipboard: Transfers the contents of the IIgs clipboard to the server
VNC Server Interoperability 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. Here is a list of some VNC servers; many others are also available. VNCview GS should be able to connect with any VNC server that fully implements the RFB protocol as defined in RFC 6143 or earlier compatible specifications. Here is a list of some VNC servers; many others are also available.
Microsoft Windows, *nix (X11), and OS X: RealVNC, http://www.realvnc.com/ Microsoft Windows, *nix (X11), and OS X: RealVNC, http://www.realvnc.com/
OS X: Vine Server (OSXvnc), http://www.testplant.com/dlds/vine/ OS X: Vine Server (OSXvnc), http://www.testplant.com/dlds/vine/
@ -59,6 +63,11 @@ x11vnc is a good option, because it supports server-side display scaling, which
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. 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 Version History
1.0
Optimized raw pixel decoding routines
Raw pixels can be decoded and displayed incrementally while receiving data
Added option to tune Marinetti for high throughput
1.0b2 1.0b2
First open source release First open source release
Can display the mouse cursor from the server locally on the IIgs Can display the mouse cursor from the server locally on the IIgs
@ -80,7 +89,7 @@ Bug causing problems with 2nd and subsequent connections fixed
First public release First public release
License License
Copyright (c) 2002-2015 Stephen Heumann Copyright (c) 2002-2016 Stephen Heumann
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

View File

@ -11,7 +11,7 @@ __Binary downloads are on the [releases page][releases].__
System Requirements System Requirements
------------------- -------------------
* An Apple IIgs running System Software 6.0.1 or later * An Apple IIgs running System Software 6.0.1 or later
* [Marinetti][1] 2.0 or later (latest version recommended) * [Marinetti][1] (latest version recommended)
* Andrew Roughan's [Crypto Tool Set][2] (needed for password functionality) * Andrew Roughan's [Crypto Tool Set][2] (needed for password functionality)
* A computer running a VNC server to which you have access * A computer running a VNC server to which you have access
@ -22,6 +22,8 @@ Strongly recommended:
A IIgs connected to the network via an Ethernet connection and a server connected to your LAN will probably provide the best performance. A IIgs connected to the network via an Ethernet connection and a server connected to your LAN will probably provide the best performance.
Under Sweet16, there is a known issue where the networking code within Sweet16 may drop the connection to the VNC server. This generally occurs at relatively low emulated speeds; you can usually avoid it by using high or unlimited speed.
[1]: http://www.apple2.org/marinetti/ [1]: http://www.apple2.org/marinetti/
[2]: http://members.iinet.net.au/~kalandi/apple/crypto.html [2]: http://members.iinet.net.au/~kalandi/apple/crypto.html
@ -40,7 +42,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. * __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. * __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. 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. 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 very slow network links. Some servers may not support Hextile encoding, in which case Raw will be used regardless of this setting.
The __Tune Marinetti for high throughput__ option configures Marinetti to process a larger amount of incoming data at once than it does by default. This generally improves performance.
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. 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.
@ -57,7 +61,7 @@ __Edit->Send Clipboard__: Transfers the contents of the IIgs clipboard to the se
VNC Server Interoperability 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. Here is a list of some VNC servers; many others are also available. VNCview GS should be able to connect with any VNC server that fully implements the RFB protocol as defined in RFC 6143 or earlier compatible specifications. Here is a list of some VNC servers; many others are also available.
* Microsoft Windows, *nix (X11), and OS X: __RealVNC__, http://www.realvnc.com/ * Microsoft Windows, *nix (X11), and OS X: __RealVNC__, http://www.realvnc.com/
* OS X: __Vine Server (OSXvnc)__, http://www.testplant.com/dlds/vine/ * OS X: __Vine Server (OSXvnc)__, http://www.testplant.com/dlds/vine/
@ -69,6 +73,11 @@ VNCview GS does not work with the Screen Sharing functionality in OS X, because
Version History Version History
--------------- ---------------
##### 1.0
* Optimized raw pixel decoding routines
* Raw pixels can be decoded and displayed incrementally while receiving data
* Added option to tune Marinetti for high throughput
##### 1.0b2 ##### 1.0b2
* First open source release * First open source release
* Can display the mouse cursor from the server locally on the IIgs * Can display the mouse cursor from the server locally on the IIgs
@ -91,7 +100,7 @@ Version History
License License
------- -------
Copyright (c) 2002-2015 Stephen Heumann Copyright (c) 2002-2016 Stephen Heumann
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: