bump version to 0.82 and prepare for release
[catagits/fcgi2.git] / README
diff --git a/README b/README
index 2e90d7d..8140968 100755 (executable)
--- a/README
+++ b/README
 FastCGI Developer's Kit README
 ------------------------------
 
-    Version 2.0b2, 04 April 1997
-    $Id: README,v 1.2 1999/06/07 05:03:47 roberts Exp $
+    $Id: README,v 1.24 2004/01/31 17:47:06 robs Exp $
     Copyright (c) 1996 Open Market, Inc.
-    See the file "LICENSE.TERMS" for information on usage and redistribution
+    See the file "LICENSE" for information on usage and redistribution
     of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 
 Basic Directions
 ----------------
 
-Open the kit's index page, index.html in this directory, using the
-"Open File" command in your Web browser.  The index page gives you an
-overview of the kit structure and helps you navigate the kit. The
-index page also contains links that run some example applications, but
-the applications won't work when index.html is opened using the "Open
-File" command because they aren't being accessed through a Web server.
-
-For further instructions see the FastCGI Developer's Kit
-document, accessible via the index page.
-
-
-TODO:
-----
-The following is a small list of what should be available in the final
-release of the FDK.
-  1. Fix all compilation problems on all Unixes and NT. 
-  2. Provide perl.c for perl5.003 (replace run() with runops())
-  3. Provide latest Tcl patches (NT requires Tcl7.5+)
-  4. Provide FCGI_VERSION directive for automatic version recognition.
--- if available
-  5. Provide new Java interface to conform to JDK1.1.1 (due to final
-     System.in)
-  6. Provide samples of Perl on NT.
-  
-
-Changes with devkit 2.1.1
+Unix:
+
+    ./configure
+    make
+    make install
+
+Win32:
+
+    nmake -f Makefile.nt
+
+    (or use the MSVC++ project files in the Win32 directory)
+
+
+CHANGES
+-------
+
+For more detail regarding changes, please consult the cvs log available 
+on http://fastcgi.com/.
+
+2.4.1
+-----
+
+ *) [WIN32] Raise SIGTERM from the ShutdownRequestThread to emulate 
+    the Unix behaviour.  Dan [mail@daniel-albert.de]
+
+ *) Fix fcgi_streambuf::underflow() such that when there is no buffer
+    the character isn't removed.  AIDA Shinra <shinra@j10n.org>
+ *) Add attach() and detach() support.
+
+
+2.4.0
+-----
+
+ *) When closing connections, shutdown() the send side of TCP sockets to 
+    prevent a TCP RST from trashing the reciept of data on the client (when
+    the client continues to send data to the application).
+
+ *) [WIN32] force an exit from the ShutdownRequestThread when a shutdown is
+    signaled and NamedPipes are in use.
+
+ *) Use streamsize and char_type in the C++ API.
+
+ *) [WIN32] Eliminate the (partial and broken) use of OverlappedIO - this 
+    was causing a loose spin in acceptNamedPipe().
+
+ *) Fix a bug that caused an assert to pop when an async file descriptor was
+    numbered greater than 16. Kevin Eye [eye@buffalo.edu]
+
+ *) Update the echo-cpp example to show the restoral of the original
+    streambufs.  Trub, Vladimir [vtrub@purolator.com]
+
+ *) Fix a bug a that caused the lib to crash under certain circumstances
+    when an error occured on a read
+
+ *) Test for iostreams that support a streambuf assigment operator
+
+ *) (WIN32) Fixed initialization of the accept mutex when OpenSocket() was used.
+    Niklas Bergh [niklas.bergh@tific.com]
+
+
+2.2.2  
+-----
+
+ *) Added support for shared libraries.
+
+ *) Added support for a graceful shutdown via an event under Win32.
+
+ *) Added default signal handlers for PIPE, USR1, and TERM.
+
+ *) Fix some minor bugs in the 0S_ layer.
+
+ *) Fixed the C++ streambuf implementation.
+
+
+Changes with devkit 2.1.1 
 -------------------------
-  
+
+ *) Fixed an unintentional sign extension during promotion  in Java's
+    FCGIInputStream.read(). Takayuki Tachikawa <tachi@po.ntts.co.jp>
+
+ *) Cleaned up warnings in examples (mostly main() complaints).
+
+ *) Removed examples/tiny-cgi.c (it wasn't a FastCGI application?!).
+
+ *) Remove some debugging code and clean up some gcc warnings in cgi-fcgi.c.
+
+ *) Add multithread support to the fcgiapp lib and an example multithreaded
+    application, threaded.c.  Based on work by Dennis Payne
+    <dpayne@softscape.com> and Gene Sokolov <hook@aktrad.ru>.
+
+ *) Remove the printf() and #include of stdio.h from examples/echo2.c.
+
+ *) Remove the static initialization of _fcgi_sF[] because on glibc 2.x based
+    systems stdin/stdout/stderr are no longer static.
+
  *) Flush FastCGI buffers at application exit.  <eichin@fastengines.com>
-    
+
  << INSERT OTHER STUFF HERE >>
+
 
 What's New: Version 2.0b2, 04 April 1997
 --------------------------------------
@@ -51,7 +118,7 @@ of the bugs that have been and fixed:
   1. Updated build_no_shell.bat to create a FcgiBin directory under the
      top level of the FastCGI kit and copy all executables and the
      FastCGI dll there.  This makes it easier to use.
-  2. Corrected the Unix version of OS_SpawnChild so that it didn't close 
+  2. Corrected the Unix version of OS_SpawnChild so that it didn't close
      the listenFd when forking off child processes.  This code would
      affect the cgi-fcgi application on Unix.  The problem is that it
      could only start one fastcgi process.  Any other processes would not
@@ -61,20 +128,20 @@ of the bugs that have been and fixed:
      the Windows NT port.  The problem was not clearing a bit indicating
      that a read had completed.  This caused the application to stall.
   4. Corrected OS_DoIo, the function used for scheduling I/O for cgi-fcgi.
-     It had a bug where it wasn't creating a copy of the file descriptors 
-     used for I/O.  This would cause the master list of FDs to watch to be 
+     It had a bug where it wasn't creating a copy of the file descriptors
+     used for I/O.  This would cause the master list of FDs to watch to be
      reset and thus would hang the application because we would no longer
      watch for I/O on those file descriptors. (This problem was specific to
      Unix and only happened with the cgi-fcgi application.)
   5. Cleaned up several compilation warnings present on OSF.
-     
+
 
 What's New: Version 2.0b1, 24 March 1997
 --------------------------------------
 
 This "beta" release adds the functionality of "cgi-fcgi" to the
 Windows NT platform and allows for creation of FastCGI applications
-running in Win32 environment.  There is almost no new documentation 
+running in Win32 environment.  There is almost no new documentation
 provided, but will become part of this kit in the official release.
   1. Added FastCGI libraries running on Windows NT 3.51+
   2. Rename errno to FCGI_errno in the FCGX_Stream, which was causing
@@ -86,13 +153,13 @@ What's New: Version 1.5.1, 12 December 1996
 --------------------------------------
 
 This release introduces mostly bug fixes, without any additional
-functionality to the kit.  
+functionality to the kit.
   1. Conditional compilation for the hp-ux compiler.
   2. Loop around the accept() call to eliminate "OS Error: Interrupted
      System Call" message from appearing in the error logs.
-  3. Casting of the FCGI_Header to (char *), which eliminates the 
+  3. Casting of the FCGI_Header to (char *), which eliminates the
      assertion failure "bufPtr->size>0".
-  
+
 
 What's New: Version 1.5, 12 June 1996
 --------------------------------------
@@ -222,7 +289,7 @@ First public release; new license terms on all files.
 Changed cgi-fcgi.c to use SO_REUSEADDR when creating the listening socket;
 this avoids the need to wait through the TIME_WAIT state on all the TCP
 connections made by the previous instance of an external application
-you are restarting. 
+you are restarting.