HOW TO INSTALL HylaFAX v4.0 client ON SCO UNIX ver4.2 1. Overview 2. System Dependencies 3. Getting the distribution package 4. Installing the distribution 5. Configuration of HylaFAX client 6. Make Symbolic links 7. Setting the FAXSERVER environment variable. 8. Testing OVERVIEW [This document augments the normal materials provided with the HylaFAX v4.0 source distribution. All HylaFAX v4.0 documentation is available on-line on the World Wide Web (WWW) at the HylaFAX Home Page http://www.vix.com/hylafax/] HylaFAX is a facsimile system for UNIX systems. It supports: - sending facsimile (sendfax(1)); - receiving facsimile; - polled retrieval of facsimile (sendfax(1)); - sending messages to pager through SNPP (sendpage(1)); - transparent shared data use of the modem (faxgetty(1M)); Facsimile can be any size (e.g. A4, B4), either 98 or 196 lpi, and transmitted/received as either 1D-encoded or 2D-encoded facsimile data (2D-encoded data is frequently more compact and hence takes a shorter time to communicate). Outgoing documents can be any format; the sendfax program uses a rule-based definition file similar to the System V /etc/magic file to deduce document types and to decide how to convert each document to a form suitable for transmission (either PostScript or TIFF/F). Automatic cover page generation (faxcover(1)) is supported and users can easily tailor cover pages to their environment. A simple text-based phonebook database is supported by sendfax. Information is also provided on how to easy setup an email to fax gateway service. Incoming facsimile are stored in a receiving area as TIFF/F files and may be automatically delivered by mail and/or printed; see faxrcvd(1M). A fax server status program, faxstat(1), can be used to monitor the send and receive queues, as well as the state of facsimile servers. Fax modems may be shared with outgoing data communication applications that honor the "uucp locking protocol". These applications typically include: cu, tip, kermit, uucp, slip, and ppp. The system can also be configured to enable incoming data calls to cause the system to invoke the standard system getty program. The software is structured around a client-server architecture. One facsimile server process (faxgetty(1M)) exists for each fax modem on a network and one server process ( faxq(1M)) for each fax-queue on a computer on a network. Clients may send facsimile from any machine that can communicate with the machine(s) on which the server(s) reside. The server side of the protocol is handled by the daemon (hfaxd(1M)) the protocol itself is implemted in form of the standard FTP protocol. Client software is designed to be lightweight and easy to port; imaging can be offloaded to the server or done on the client. (Imaging is, however, typically done on the server because it simplifies administration.) Multiple modems may be located on a single machine. An access control mechanism is included to control which users on which machines may submit documents for transmission. The system supports a wide variety of fax modems. Any Class 1, Class 2, Class 2.0 modem should work with the system. There is also support for pager devices. Please report all problems & bugs regarding this binary distribution to me, Tim Rice Disclaimer: 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. In addition for the binary distribution: IN NO EVENT SHALL TIM RICE OR MULTITALENTS 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. SYSTEM DEPENDENCIES The binary distribution package of HylaFAX v4.0 client is available in tar(C) format and was compiled under Altos/SCO UNIX Version 4.2aC0 with GNU gcc version 2.7.2.1 and libg++ 2.7.2. The package contains a complete set of clients to be able to connect ot another machine running the HylaFAX server. The installation and execution of version (HylaFAX client v4.0pl2) was tested on the following x86-based systems. - Clone i486DX33 running Altos/SCO Open Server Enterprise Ver. 3.0aC0 To install and run HylaFAX client v4.0 you need the following ressources on your system: - You MUST have TCP/IP installed. - a minimum free diskspace of 2.5MB on the /usr filesystem use df(1) to check this out; - a minimum free diskspace of 2.5MB on the /tmp filesystem while running ftp and unpacking the distribution; - the ability to become root to install the package; You need a binary of gzcat. If you don't have it, get a copy from ftp://ftp.sco.com/Skunk1/CD-ROM/bin/gzcat gzcat is under the GNU Public License. The source for it could be retrieved by ftp from prep.ai.mit.edu. GETTING THE DISTRIBUTION PACKAGE The package is available for free from ftp://ftp.sgi.com/sgi/fax/binary/hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz If you retrieve the package from any ftp-server you should check the sum(C) or the MD5 value of the package: The correct values are: sum(C): 56801 1630 hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz MD5 (hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz) = 9429e278ad80b4d4c2acdbc6e7b543d1 INSTALLING THE DISTRIBUTION To install the image hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz do the following steps as root: # cp hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz /tmp # cd / # gzcat /tmp/hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz | tar xvf - # rm /tmp/hylafax-client-sco3.2v4.2-v4.0pl2.tar.gz This will install the sco3.2v4.2 binary distribution of HylaFAX client under: /usr/local/HylaFAX-v4.0/... /usr/local/share/ghostscript/fonts/... No other parts of your system will be touched during this step of installation This HylaFAX client distribution was compiled with the following configuration parameters: [ 1] Directory for applications: /usr/local/HylaFAX-v4.0/bin [ 2] Directory for lib data files: /usr/local/HylaFAX-v4.0/lib [ 3] Directory for lib executables: /usr/local/HylaFAX-v4.0/slib [ 4] Directory for system apps: /usr/local/HylaFAX-v4.0/sbin [ 5] Directory for manual pages: /usr/local/HylaFAX-v4.0/man [ 6] Directory for HTML documentation: /usr/local/HylaFAX-v4.0/html [ 7] Directory for spooling: /usr/local/HylaFAX-v4.0/spool [ 8] Directory for font metrics: /usr/local/share/ghostscript/fonts [ 9] Directory for uucp lock files: /usr/spool/uucp [10] Uucp lock file scheme: -ascii [11] PostScript imager package: gs [12] PostScript imager program: /usr/local/bin/gs [13] Manual page installation scheme: sysv-source-cat [14] Default page size: North American Letter [15] Default vertical res (lpi): 98 [16] Location of getty program: /etc/getty [17] Location of voice getty program: /bin/vgetty [18] Location of sendmail program: /usr/lib/sendmail [19] Location of TIFF tools: /usr/local/HylaFAX-v4.0/tiffbin Several of the above pathnames are compiled into applications included in this binary distribution. If any of these pathnames are unacceptable, your only options are to create a symbolic link to the installed directory hierarchies or retrieve the HylaFAX source distribution and recompile from scratch. Some of the above parameters can however be changed by editing various configuration files, see also config(4F). CONFIGURATION OF HylaFAX client If you have access to the World Wide Web, go to the HylaFAX Home Page at http://www.vix.com/hylafax/ and read the documentation. In particular, read the information that describes how to setup a fax server. Online documentation is also available through the manual pages; consult hylafax(1) and hylafax(4F) for introductory information on the client applications and the server setup, respectively. In order to run HylaFAX client you need to be connected via TCP/IP to a computer running the HylaFAX server software. As root and run faxsetup(1M): # sh /usr/local/HylaFAX-v4.0/sbin/faxsetup -client Here is the log of the messages, questions and answers during faxsetup and faxaddmodem. At any time you might safely interrupt faxsetup or faxaddmodem without causing any problems. Users upgrading from pl0 or pl1 will see fewer messages from faxsetup. Users upgrading from pl0 or pl1 do not need to run faxaddmodem. Setup program for HylaFAX (tm) v4.0pl2. Created for i486-unknown-sco3.2v4.2 on Mon Feb 23 19:44:59 PST 1998 Checking system for proper client configuration. Warning: No hylafax service entry found! No entry was found for the hylafax service in the YP/NIS database or in the /etc/services file. The software should work properly without one (except if you want to start hfaxd from inetd), but you will see warning messages whenever you run a HylaFAX client application. If you want to manually add an entry the following information should be used: hylafax 4559/tcp # HylaFAX client-server protocol Should a hylafax entry be added to /etc/services [yes]? yes Warning: No snpp service entry found! No entry was found for the Simple Network Paging Protocol (SNPP) service in the YP/NIS database or in the /etc/services file. The software should work properly without one (except if you want to start hfaxd from inetd), but you will see warning messages whenever you run the HylaFAX sendpage program. If you want to manually add an entry the following information should be used: snpp 444/tcp # Simple Network Paging Protocol Should an snpp entry be added to /etc/services [yes]? yes Done verifying system setup. MAKE SYMBOLIC LINKS Go into /usr/local/HylaFAX-v4.0 and run make.links. This will make links to the user programs and the man pages. # cd /usr/local/HylaFAX-v4.0 # sh make.links SET THE FAXSERVER ENVIRONMENT VARIABLE Add the FAXSERVER environment variable to your /etc/profile and /etc/cshrc. Eg. for /etc/profile FAXSERVER=some_host_with_fax_server ; export FAXSERVER and /etc/cshrc setenv FAXSERVER some_host_with_fax_server Make sure the machine with the fax server has your client machine in it's ..../spool/etc/hosts file. TESTING To test your installation once you've configured your fax server and modem, startup the fax server as shown above and then log out as root and log in again as a "normal" user. First check with faxstat(1) to make sure the server is running: $ faxstat -s the hfaxd(1M) daemon should respond with something like: $ faxstat -s HylaFAX scheduler on trrsco: Running Modem ttyy1H (+1.xxx.xxx-xxxx): Running and idle $ then send a short fax (change +123456789 below to the number of a nearby fax machine): $ sendfax -n -d +123456789 <