README

   1
   2                           Introduction
   3
   4 This is the README file for version 0.9 of efax, a small ANSI
   5 C/POSIX program that sends and receives faxes using any fax modem
   6 (Class 1, 2 or 2.0).
   7
   8 efax is smaller and easier to install than HylaFAX or
   9 mgetty+sendfax.  As one user put it ``EFAX is a nice simple
  10 program for single user systems.''
  11
  12 The ``fax'' command, a shell script, lets you send, receive, view
  13 and print faxes.  In larger systems, faxes can be sent by
  14 printing to a ``fax'' printer and received faxes can be e-mailed
  15 as MIME attachments to an administrator for distribution.  efax
  16 can also pass incoming data calls to a getty program.
  17
  18 The efax package includes ``efix,'' a program to convert between
  19 various image file formats.  To fax Postscript files you will
  20 need Ghostscript.  To view faxes you can use any program that
  21 displays PGM files (e.g. xloadimage or xv).  efix can convert
  22 received files to Postscript or HP Laserjet formats for printing.
  23
  24 This version of the program was written & tested under Linux 2.0.
  25 Previous versions have been compiled and used under most versions
  26 of Unix and should work with minor changes on any Unix with an
  27 ANSI C compiler and libraries that include select(2) and
  28 termios(4).
  29
  30 efax is distributed as a gzip'ed tar file, efax-0.9.tar.gz.  It
  31 may be obtained by anonymous FTP from metalab.unc.edu in
  32 /pub/Linux/apps/serialcomm/fax.
  33
  34             Changes from version 0.8a to version 0.9
  35
  36 - fixed bad (0x0 pixel) file output on new glibc systems
  37
  38 - fixed bad file output on 64-bit systems
  39
  40 - automatic selection of baud rate and class
  41
  42 - hardware flow control made optional
  43
  44 - modernized directory and file names
  45
  46 - many bugs removed, others added
  47
  48                             Manifest
  49
  50 The efax distribution should contain the following files:
  51
  52 README         - this file
  53 COPYING        - the GNU General Public License
  54 Makefile       - makefile to make all/install/clean
  55 efax.c         - program to send and receive faxes
  56 efix.c         - program to convert between file formats
  57 efaxmsg.{h,c}  - functions to print errors, warnings, etc
  58 efaxlib.{h,c}  - functions common to efax and efix
  59 efaxio.{h,c}   - low-level modem i/o functions
  60 efaxos.{h,c}   - OS-dependent functions
  61 fax.1          - man page for fax(1)
  62 efax.1         - man page for efax(1)
  63 efix.1         - man page for efix(1)
  64 fax            - a (Bourne) shell script to create, send,
  65                  receive, view and print faxes.
  66
  67                           Installation
  68
  69 Edit the makefile and change the compile command and destination
  70 directories if required.
  71
  72 Type "make" to compile the efax and efix binaries.
  73
  74 Edit the configuration information at the beginning of the
  75 ``fax'' script according to the comments.
  76
  77 Type "make install" to install the fax script, the binaries and
  78 the man pages.
  79
  80 Read the fax(1) man page first for information on using efax.
  81
  82 The efax(1) man page has details on resolving problems, setting
  83 up a network fax server and using efax to handle both fax and
  84 data calls.