Beef up the `unfinished and experimental' warnings for the two Mac

[u/mdw/putty] / mac / README.mac

diff --git a/mac/README.mac b/mac/README.mac
index e5e359f..4b141e5 100644 (file)
--- a/mac/README.mac
+++ b/mac/README.mac
@@ -1,8 +1,14 @@
-$Id: README.mac,v 1.9 2003/01/05 15:31:45 ben Exp $
+$Id$
 
 Information about PuTTY for the Mac OS
 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
+This is a port of PuTTY to the Classic Mac OS.  It is a work in
+progress and should be considered unfinished and insecure.  It is
+not considered to be of release quality, even if you found it (and
+you're reading this) in a PuTTY release source archive.  Unless you
+know what you're doing, don't use it.
+
 Compiling it:
 
  See ../README for generic information.
@@ -12,23 +18,34 @@ Compiling it:
  MPW
   <ftp://ftp.apple.com/developer/Tool_Chest/Core_Mac_OS_Tools/MPW_etc./
    MPW-GM_Images/MPW-GM.img.bin>
+  Install this in the usual way.
 
- Universal Headers (optional)
+ Universal Headers
   <ftp://ftp.apple.com/developer/Development_Kits/
    UniversalHeaders3.4.2.img.bin>
+  Install using the script in "Documentation:MPW Users - ReadMe".
 
  Text Encoding Converter SDK
   <ftp://ftp.apple.com/developer/Development_Kits/TEC_1.5.sit.hqx>
-
- Install MPW, install the new Universal Headers (optional), then put
- the contents of the "68K Static Libraries" directory of the Text
- Encoding Converter SDK into "Interfaces&Libraries:Libraries:Libraries",
- and the contents of the "Stub Libraries" directory into
- "Interfaces&Libraries:Libraries:SharedLibraries".
+  Copy contents of "68K Static Libraries" to
+   "Interfaces&Libraries:Libraries:Libraries".
+  Copy contents of "Stub Libraries" to
+   "Interfaces&Libraries:Libraries:SharedLibraries".
+
+ CarbonStdCLib.o
+  <ftp://ftp.apple.com/developer/Tool_Chest/Core_Mac_OS_Tools/
+   MPW_Website_Downloads/CarbonStdCLib.o-3.8d3.hqx>
+  Copy contents of "CIncludes" to
+   "Interfaces&Libraries:Interfaces:CIncludes".
+  Copy contents of "PPCLibraries" to
+   "Interfaces&Libraries:Libraries:PPCLibraries".
 
  The "mkputty.mpw" script does all the work, and currently producess a
- Classic 68K build of PuTTY called "PuTTY.68k", a CFM-68K build called
- "PuTTY.cfm68k", and a non-Carbon PowerPC build called "PuTTY.ppc".
+ Classic 68K build of PuTTY called "PuTTY.68k", a non-Carbon PowerPC
+ build called "PuTTY.ppc", and similar builds of PuTTYtel called
+ "PuTTYtel.68k" and "PuTTYtel.ppc".  The CFM-68K build is currently
+ disabled because it overflows the global data space and I can't work
+ out how to stop this happening.  The Carbon build doesn't work yet.
 
 Runtime requirements:
 
@@ -42,21 +59,45 @@ Runtime requirements:
  The PowerPC build of PuTTY should work on any Power Macintosh.  It
  runs in the Classic environment in Mac OS X.
 
-Known bugs:
+ The Carbon build of PuTTY (when it works) should work on any Power
+ Macintosh with CarbonLib (and Mac OS 8.1 or later), Mac OS 9 or
+ Mac OS X installed.
 
- * PowerPC and fat versions fail to start on systems without AppearanceLib (ie
-   most System 7 ones).  The 68k version works fine. [MAYBE FIXED]
+Known bugs:
  * Display is far too slow.
  * Real bold doesn't compensate for changing character widths without Color
    QuickDraw. [MAYBE FIXED]
-
-Features we need (and aren't entirely obvious):
-
+ * When the last terminal window closes, the Edit menu doesn't get disabled
+   immediately, which it should.
+ * When using the "VT100" font, text copied to the clipboard doesn't
+   get newlines in it, because that font has a graphic character at
+   position 0x0d.  Even if we did insert 0x0d manually, TextEdit
+   insists on displaying the graphic version, so I think we need a
+   font switch at this point.  This can be seen as a special case of
+   the need to switch fonts to get odd characters.
+ * Pasting large blocks of text doesn't work.
+ * The host key database is currently limited by its implementation to
+   2727 host keys.
+
+Unimplemented features (should be done before release):
  * TCP urgent data.
- * Scroll-conflation -- scroll_display should change the in-memory
-   display and remember the scroll, then do_scroll should be called
-   only when scroll_display gets called for a different rectangle or
-   term_paint happens.
+ * Listening sockets.
+ * Changing font size in reponse to resize requests.
+ * Full screen mode.
+ * Session configuration. 
+ * Entropy collection.
+ * Private key files.
+ * Pageant and PuTTYgen.
+ * Do something with Open Application Apple Events.
+ * Close-on-exit.
+ * Warn-on-quit.
+ * Non-block cursors.
+
+Wishlist (after release):
+ * SFTP client (GUI?)
+ * Carbon compatibility (requires Open Transport and Navigation Services).
+ * 'styl' paste, for script codes.
+ * Handle 'gurl' Apple Events.
 
 Local Variables:
 mode: text