HYLAFAX TABLE OF CONTENTS

This is the table of contents for the documentation included with the HylaFAX software distribution. A version of this documentation is available on the main web site at www.hylafax.org/toc.html. If you are looking for ancillary materials such as the FAQ or mailing list archives, consult the section on supporting materials

BASIC INFORMATION

- HylaFAX overview
  An introduction to the software's features and some general information on its structure and the organization of the documentation.
- Where to get the HylaFAX distribution
  This is the definitive answer to where to get a distribution, be it source or binary.
- How to tell which version of HylaFAX you have
  Instructions on how to concisely identify the software version from a source or binary distribution; critical when reporting problems.
- Which modems can be used with HylaFAX
  General information on what types of fax modems can be used with the software and a table of specific modems that have been tried. This section also includes modems that are recommended for use with this software.
- About the Class 1 modem support
  Important information about limitations in the use of this software with Class 1 modems.
- About the Class 2 modem support
  Information about the support and how to deal with a common deficiency in these modems.
- About the Class 2.0 modem support
  Some quick comments about these new-style modems.
- About the source distribution
  Introduction to the source distribution and the requirements for building the software.
- About the binary distribution
  Information on where to locate binary distributions and how to interpret their packaging.
- Upgrading from HylaFAX Version 3.0
  Guidance for users upgrading from the last HylaFAX release to the current distribution; specifically what has changed in incompatible ways that you should be aware of.

BUILDING FROM SOURCE

- How to build the software from source code
  The critical chapter to read when working with the source distribution. The information in this chapter may also be useful to folks working with binary distributions.
  - Before You Start
    If you do not read this section before you run configure then you may do extra work and get pretty frustrated.
    - TIFF
    - gcc
    - C++ runtime libraries
    - ghostscript
    - gmake
    - gawk
    - sed
    - /bin/test
    - ps2fax binary for IRIX systems
  - The Build Procedure
    When the software builds without a hitch you can ignore this stuff; but if not be prepared to spend some time reading the fine print.
    - Build Trees
    - Configuration Files
    - Configuring Packages
    - Configuring the HTML Documentation
    - Upgrading From FlexFAX
    - A Sample Configuration Session
    - Configuration Parameters
  - Troubleshooting Build Problems
    Building this software is bulletproof; you'll never need this stuff...right!
  - System-specific Guidance
    Information about pitfalls for specific systems are provided; some of this stuff is just too hard to handle automatically in the normal build support.
- Building Ghostscript for use with HylaFAX
  Quick help on what to do to create a version of Ghostscript suitable for use as the PostScript Raster Image Processor (RIP) that HylaFAX uses to image outbound facsimile documents.

SETUP INFORMATION

- Basic server configuration
  Step by step instructions on setting up a server machine once the software is installed from a source or binary distribution. This material describes only the basic work required to get a system running.
  - Selecting a Facsimile Modem
    So you got this software but no modem; have no fear.
  - Checking your Modem
    A primer on what a fax modem looks like; in case you somehow did not follow the instructions on selecting a modem.
  - Selecting a Flow Control Scheme
    You may think you know all about modems and flow control but when it comes to facsimile you might be surprised!
  - Choosing a TTY Device
    This stuff should be straightforward but some vendors do their best to confuse the issue.
  - Using faxsetup to Configure a Server Machine
    The heart of the setup procedure; this is where HylaFAX tries to make sure you get things installed and setup correctly.
  - Using faxaddmodem to Configure Modems
    The tool you will want to use to initially setup and configure a modem for use.
  - Starting Outbound Service
    Most of this stuff is done when you run faxsetup but you will want to know what is happening for other times.
  - Setting up Inbound Service
    Arranging to handle inbound calls requires some manual configuration of system files because every system does this differently.
  - Settting up Client Access
    How to run the client-server protocol process that all the client applications talk to and how to configure user access.
  - Setting up Periodic Maintenance Work
    If you do not arrange for some scripts and programs to be run periodically on your server system then you will be sorry.
  - Modem Configuration Issues
    Some stuff you should be aware of when running HylaFAX; how it might affect your other system applications.
  - System-specific Setup Advice
    System-specific tidbits about setting up a HylaFAX server machine.
    - IRIX-specific Guidance
    - SCO-specific Guidance
    - Solaris-specific Guidance
    - SunOS-specific Guidance
    - SVR4-specific Guidance
    - Ultrix-specific Guidance
- Advanced server configuration
  Information about optional facilities provided by HylaFAX. The material here is typically short and introductory with more complete information found in the reference documentation (manual pages). The last few sections give some background information about how the various modem-related configuration parameters fit together so that you can understand how the large set of tunable parameters can be most effectively used.
  - Local Identifier Support
    How to setup a string that identifies yourself to folks that receive your facsimile.
  - Dial String Rules
    How HylaFAX processes cient-specified phone numbers and the like.
  - Tagline Support
    Setting up that line of text across the top of each transmitted page of a facsimile.
  - Adaptive Answer Support
    Hints on configuring a modem for combined fax and data use.
  - Caller-ID Support
    How to enable the caller-ID support and use it to screen inbound calls.
  - Distinctive Ring Support
    How to distinguish the type of inbound calls based on distinctive ring patterns.
  - Copy Quality Checking
    Page quality checking of received facsimile documents.
  - Continuation Cover Pages
    Enabling the automatic generation of cover pages for facsimile that are retried after a communication error.
  - Time-of-Day Usage Scheduling
    How to constrain outbound calls based on the destination and the time of day.
  - Per-destination Controls
    The general per-destination control facilities provided by HylaFAX.
  - Page Chopping Support
    How to get HylaFAX to truncate facsimile pages that have lots of trailing white space.
  - Modem Groups
    How to setup groups of modems for outbound use.
  - Modem Priorities
    How to prioritize modems for outbound use.
  - Transcoding of Received Facsimile
    Automatically converting the data format of received facsimile for optimal storage.
  - Automatic Processing of Received Facsimile
    How to automatically process (deliver and/or print) received facsimile.
  - Rejecting Junk Facsimile
    How to screen inbound facsimile calls based on the sender's purported identity.
  - UUCP Lock Files
    A quick overview of the UUCP locking scheme and how to tailor it for non-standard systems.
  - Modems that Lie about their Capabilities
    Some tricks to use when modems are not quite what they claim to be.
  - Configuration Parameter Usage During Modem Setup
    How the configuration parameters get used when a modem is initialized for use.
  - Modem Parameter Usage for Outbound Calls
    How the configuration parameters get used during facsimile transmission.
  - Modem Parameter Usage for Inbound Calls
    How the configuration parameters get used during an inbound call.
- Alpha-numeric pager support
  Setting up the optional facility for sending alpha-numeric messages to pager devices using the IXO/TAP or UCP communication protocol.
  - Setting up SNPP
    SNPP is the protocol used by client applications to submit requests to send pages.
  - Setting up Pagesend
    This is the backend program that does the actual delivery of the a page request by talking IXO/TAP or UCP over a phone connection to a paging service provider.
- How to setup a client.
  What to do to setup a system that is going to run only the client software.
- About server operation.
  Quick description of what goes on on a server machine and what administrative tasks must be managed for a server. The material in this section is mostly a reiteration of information in other sections from an administration perspective.
- How to setup a mail to fax gateway
  It is simple to arrange for electronic mail messages to automatically get submitted as facimile. HylaFAX includes fairly extensive support for controlling the content and delivery of facsimile submited in this way.

TROUBLESHOOTING

- Troubleshooting HylaFAX Problems
  If you have a problem this is where to start. This chapter discusses the facilities provided by HylaFAX for diagnosing problems and gives specific examples of how to use them. There are also comments about the most frequently encountered problems. The material in this chapter is supplemented by the HylaFAX Frequently Answered Questions document (HylaFAQ) which is updated more frequently than this documentation and often contains information relevant to problems with specific distributions.
  - Client Basics
    If you are running a client command line application such as sendfax or faxstat and do not know where to begin then this is the place.
  - Client Access Control Problems
    What to do when a server will not let you in but you think should be allowed. Be sure that basic communication with the server works before trying the advise given here.
  - Server Basics
    Basic information that you need to get started debugging problems that might occur on a server machine. You will find information here about the tracing logs that are the key to understanding server problems.
  - Scheduler Operation
    When the central scheduler will not process your job or it is not doing what you expect read this section.
  - Session Tracing
    An introduction to the session tracing logs maintained for all phone calls serviced by HylaFAX.
  - PostScript Document Preparation
    What to try when you just can not figure out why the PostScript document you submitted for transmission keeps getting rejected.
  - TIFF Document Preparation
    TIFF documents are handled just like PostScript documents; sort of. If something goes wrong sending a TIFF document and you do not understand then look here.
  - Communication Problems
    The most common area of frustration; some guidance and suggestions on what to do when a job does not go through.
  - Getty Problems
    If you encounter problems arranging for inbound data calls to be handled look here.
  - Problems With UUCP, cu, tip, etc.
    When HylaFAX and the normal system programs do not play together you may find this information useful in figuring out what is wrong.
  - Alpha-numeric pager support
    A bit of advise on common problems encountered when using the IXO/TAP or UCP support.

SUPPORTING MATERIALS

- HylaFAX Frequently Asked Questions (HylaFAQ)
  The FAQ is updated more frequently than this documentation and is also a good place to look for answers to problems specific to a particular distribution.
- HylaFAX mailing list archives
  It is a searchable archive, and is also browsable by date or subject thread. The archives start in January 1997.
- Resources and Links page
  An extensive list of all things HylaFAX on the web, including other web based fax services and FlexFAX Modem Bakeoff report
  This is a very old paper that is included just so folks will not ask me where it is.
- FlexFAX/HylaFAX modem information
  Limited information about specific modems; this was supposed to be a general repository for information but it never happened.
- ZyXEL modem voice support information
  Reference information, now old, on the ZyXEL voice command support.
- Supra/Rockwell Class 1 documentation
  An old document from Supra about their modem.
- Supra/Rockwell Class 2 documentation
  An old document from Supra about their modem.
- Telebit T3000/WorldBlazer FAX commands
  A reference card for fax commands supported in older Telebit modems.
- Hayes technical reference for modem users
  Yet another old document that has some information that might be interesting.
- Peter Chen's "What you need to know about modems"
  Some good introductory material for novices.
- FAX modem command scorecard
  An old project to collect information about what modems implement what Class 2 commands; necessary given the nonstandard nature of the Class 2 command set.

END MATTER

- About contributed software
  Some folks have contributed stuff to go with HylaFAX; check here for pointers.
- Acknowledgements
  Lots of folks have helped make this package useful; you will find some of them listed here together with attribution to the various packages that HylaFAX makes use of.
- Other documentation
  Some pointers to documentation that can be found elsewhere on the web.
- HylaFAX mailing list and other final words
  How to sign up to be on the mailing list.
- Use and copyright
  The rules for using this software. Hint: there are not many!
- TIFF information
  Information on the other major software package HylaFAX depends on that Sam Leffler created.

HylaFAX overview.