$Id: README,v 1.37 2006/12/05 04:11:03 darren Exp $

                           *   ANNOUNCE   *

The HylaFAX development team is pleased to announce our 4.3.1 release!
This release introduces a powerful new email templating system that
offers an unprecedented level of control over the branding of the
email messages HylaFAX sends, and so we encourage you to check it
out. No release would be complete without bugfixes of course, and this
one has plenty. As always, our sincerest thanks go to all who
participate in the development and testing process.

                               *   *   *

This document is intended to describe the significant differences
between hylafax-4.3.1 and older releases, point out any known
incompatibilites and issues, and provide the reader with directions to
further resources regarding HylaFAX.

                          *   NEW FEATURES   *

* Email Templating: Server administrators can now have complete
  control over the 'look and feel' of the email messages HylaFAX
  sends. We have used this only for internationalization in this
  release, but for an example of what can be done with a little
  bit of HTML, check out the hylafax-html templates at:

      http://people.ifax.com/~aidan/hylafax/templates/


                         *   KNOWN ISSUES   *

** Please refer to HylaFAX Bugzilla for a detailed list of issues.

                       *   INCOMPATIBILITIES   *

* HylaFAX no longer uses the bin/dictionary script and etc/FaxDictionary
  file to customize emails. Users requiring customized emails should
  create etc/templates/some-directory/, copy the basic *.txt templates
  into there, set the $TEMPLATE variable in etc/FaxDispatch and
  etc/FaxNotify and start hacking. 
* QualifyCID is obsolete, having been replaced by DynamicConfig in 4.3.0
* DestControls is obsolete, having been replaced by JobControl in 4.3.0
* Some modem config files generated from earlier versions' config file
  prototypes may contain Class1TCFRecvHack.  This is no longer desireable
  for production use, and this feature should now only be used for
  debugging purposes.
* If upgrading from any release older than 4.2.2, be advised
  that CIDName/CIDNumber are now part of a larger CallID framework. 
* libtiff-3.6.1 is fatally flawed when dealing with Group 3 images.  
  Don't use it as-is.  
  See: http://bugs.hylafax.org/bugzilla/show_bug.cgi?id=500

                      *   WHO SHOULD UPGRADE?   *

This release rolls up several months of development by the HylaFAX
community, and is a recommended release for all users. Notable changes
include fixes to improve the robustness of the Class 1 fax protocol,
the ability to resubmit failed faxes from the commandline, powerful
email templating, a new language (Romanian), stability improvements
for faxq, the ability to compile with shared libraries on Solaris, and
a long list of other fixes and tweaks too numerous to mention. If you
have done a lot of work with FaxDictionary to customize HylaFAX's
emails, then you might want to delay upgrading to 4.3.1 until you have
had a chance to study the new email templating system on a test server.

Anyone presently running a version of HylaFAX older than 4.3.0 and
using DestControls should study the JobControl feature we added in
4.3.0 carefully and test migration to the new framework before
upgrading a production server. Likewise, those using QualifyCID to
reject faxes from certain callers should become familar with
DynamicConfig and RejectCall.

                     *   HYLAFAX BINARY PACKAGES   *

Binary packages for some operating systems and platforms are available.  
Please see:

   ftp://ftp.hylafax.org/binary/
   http://www.hylafax.org/content/Binary_Packages
   http://www.hylafax.org/content/Handbook:Binary_Package_Install

If you are able and  willing to produce a binary package of HylaFAX for
general distribution, and one is not already available for your platform/OS,
then you are invited to add it to the Binary_Packages wiki page at
www.hylafax.org.


                       *   SUPPORT   *

HylaFAX has numerous public support resources available.  The user is
encouraged to utilize the manpage documentation before turning to
other support arenas.  However, if other support is desired, or if you
would like to actively take part in the HylaFAX community, you are
invited to:

  * join and participate in a HylaFAX mailing list
    See: http://www.hylafax.org/content/Mailing_Lists

    When corresponding about this software, please always specify:
    - what version of HylaFAX you have,
    - what system you're running on (if it is Linux please name the
      distribution)
    - if the problem is modem-related, identify it and the firmware rev
    For example: "HylaFAX 4.3.0 under CentOS 4.4 with gcc 3.4.6;
    ZyXEL 1496E with 6.11a firmware."

  * read the on-line documentation and resources
    See: http://www.hylafax.org/content/Documentation

  * review HylaFAX CVS
    See: http://www.hylafax.org/content/Developers

  * report confirmed bugs, feature requests, and submit patches
    See: http://bugs.hylafax.org/



Thanks,

  The HylaFAX development team

-------------------------------------------------------------------

And now, a note from HylaFAX's original author ;-)

Silicon Graphics has seen fit to allow me to give this work away.  It
is free.  There is no support or guarantee of any sort as to its
operations, correctness, or whatever.  If you do anything useful with
all or parts of it you need to honor the copyright notices.   I would
also be interested in knowing about it and, hopefully, be acknowledged.

Finally, note that this software is called ``HylaFAX'', not ``Hylafax'',
``hylafax'', and certainly not ``FlexFAX'' (the old name which someone
else has a copyright on).  If you want to refer to this software use
``HylaFAX (tm)'' and be sure to honor the Silicon Graphics trademark.

	Sam Leffler

Use and Copyright
-----------------

Copyright (c) 1988-1996 Sam Leffler
Copyright (c) 1991-1996 Silicon Graphics, Inc.
HylaFAX is a trademark of Silicon Graphics

    Permission to use, copy, modify, distribute, and sell this software and 
    its documentation for any purpose is hereby granted without fee, provided
    that (i) the above copyright notices and this permission notice appear in
    all copies of the software and related documentation, and (ii) the names of
    Sam Leffler and Silicon Graphics may not be used in any advertising or
    publicity relating to the software without the specific, prior written
    permission of Sam Leffler and Silicon Graphics.

    THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
    EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
    WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  

    IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
    ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
    OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
    WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
    LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
    OF THIS SOFTWARE.
