BUILDING HYLAFAX FROM SOURCE CCODE
This chapter contains the information needed to configure and build HylaFAX from the source distribution. The following sections are available here:

There are some build-related issues that are dependent on the operating system present on the machine. Some system-specific guidance is sprinkled throughout these materials; the remainder is in a section on system-specific guidance that is found at the end of this chapter.

Before You Start

Before you build the software you may need to obtain certain other software distributions. All the software packages described here are available by public FTP from a variety of Internet hosts; consult the archie resource location service to find copies close to your system.

TIFF

 HylaFAX requires version 3.4 or later of the freely available TIFF software distribution. The master FTP site for this distribution is ftp://ftp.sgi.com/graphics/tiff. Note that the TIFF distribution must be installed before building HylaFAX from source code or HylaFAX must be specially configured to search for TIFF include files and libraries in non-standard locations.

gcc

 You need a contemporary C++ compiler to build this system. gcc version 2.6.3 is the current recommended version to use; though later versions are also known to work. Versions of gcc prior to 2.6.1 will not work. When installing gcc beware of the make install step. On some systems and/or with some versions of gcc, the fax software may not compile properly if the include files are wrong (function prototypes that would normally cause type casts to be done may be missing).

C++ runtime libraries

 HylaFAX requires only minimal C++ runtime support; basic dynamic memory allocation facilities and support for creating global static objects; it does not use any of the newer C++ runtime facilities such as exception handling. Most C++ compiler packages include everything that you need in the way of a runtime library. When using GNU gcc you may also need the libg++ distribution which is packaged separately from gcc. On some systems where gcc is used these facilities can be satisfied without linking against -lg++ or -liberty, but on others one or both of these libraries are needed for certain library routines that are normally found in the C runtime library. The configuration procedure will abort if libg++ is needed but is not present on the build system. If libg++ is required you should use the version that is appropriate for the compiler. When using gcc version 2.6.3, libg++2.6.2 is the recommended version to use.

ghostscript

 If you are not on a Silicon Graphics machine (and maybe even if you are), then you will need the Ghostscript PostScript interpreter software to build a PostScript imaging engine to be used by the facsimile server. (This imaging engine is frequently referred to as a Raster Image Processor or RIP.) Ghostscript comes in three flavors, two of which are important to us: GNU PostScript, a version governed by the GNU Public License (GPL), and Aladdin Ghostscript, a version covered by the Aladdin Free Public License. Both versions are copyrighted work and are not shareware or in the public domain. Aladdin Ghostscript is free for use by end users but does not allow commercial distribution; to do this you must arrange for a commercial license. Versions of GNU Ghostscript are distributed approximately a year following the corresponding Aladdin Ghostscript version. For more information on these and other issues consult the information located at http://www.cs.wisc.edu/~ghost/ghostscript/.

Ghostscript Version 2.6.1 and later are known to work. If you use version 2.6.1 however, be certain to apply patches 1-4. If you do not apply the patches you will encounter a bug in the clipping code that is triggered by the default cover page distributed with this software. Also beware that if you use a version of Ghostscript prior to 3.12 (inclusive) that there is a tiffg32d driver that writes incorrect 2D-encoded facsimile data; either do not configure this driver for use or disable its use by setting Use2D in the HylaFAX scheduler configuration file so it does not try to generate 2D-encoded facsimile data for outbound jobs.

gmake

The make files are extensive and work untouched with the system make under many systems. If your make does not understand them, then you should be able to use the GNU make (gmake) instead. If you decide to use gmake, be sure to get version 3.63 or newer; otherwise you may encounter problems (especially with the rules that automatically generate source code dependency information).

gawk

 Several of the shell scripts included in this software make use of awk. These uses are reasonably simple, but will not work if your awk is old enough that it does not support functions or the -v command line option for setting variable values before the BEGIN action is executed. If you encounter problems using the standard awk on your system, try the GNU awk: gawk.

NOTE: When using gawk be sure to use version 2.15 or later; HylaFAX is unable to detect versions of gawk that do not work correctly.

sed

Many of the shell scripts included in this software make use of sed. Certain systems are known to have versions of sed that do not handle the shell scripts. If you encounter problems, the latest GNU sed should be substituted.

/bin/test

The software configuration shell script (configure) and the modem configuration shell script (faxaddmodem) make heavy use of the test program. On some systems the /bin/test program does not support options such as -c (test if a file is a character special device). Source for a contemporary, public domain, test program is available by public FTP from ftp.uu.net.

ps2fax binary for IRIX systems

The Display PostScript-based imager for Silicon Graphics systems is included in the binary distribution images provided on ftp.sgi.com. If you choose to work from the source code on an IRIX system you may want a copy of the ps2fax program: it is available separately on ftp.sgi.com in the HylaFAX source distribution area: ftp://ftp.sgi.com/sgi/fax/source. Note that this is a COFF executable for IRIX 4.x and 5.x systems and requires that the IRIX dps_eoe package be installed for proper use.

The Build Procedure

 To build the software you need to first run the configure shell script that is located in the top level of the source directory. This script probes the target system for necessary tools and functions and constructs a build environment in which the software may be compiled. Once configuration is done, you simply run make to build the software and then make install to do the installation; for example: In general, the software is designed such that the following should be ``make-able'' in each directory: Note that after running "make clobber" or "make distclean" the configure script must be run again to create the Makefiles and other build-related files.

Build Trees

 There are two schemes for configuring and building the software. If you intend to build the software for only one target system, you can configure the software so that it is built in the same directories as the source code.

Otherwise, you can configure a build tree that is parallel to the source tree hierarchy but which contains only configured files and files created during the build procedure.

This second scheme is useful for: Beware that if you choose to use the second scheme for configuring the software you must not use an absolute pathname when you run configure (i.e. a pathname that begins with ``/'') and the make that you use to build the software must correctly support the VPATH facility.

NOTE: HP-UX 9.05: The standard make incorrectly processes VPATH; either use gmake or configure builds in the source tree.
NOTE: Solaris 2.3: The standard make does VPATH processing incorrectly for files passed to the make dependency generator script (the last file in the list is not converted to a pathname relative to the source directory); this causes lots of messages that can be ignored.

Configuration Files

The configuration process is critical to the proper compilation, installation, and operation of the software. The configure script runs a series of tests to decide whether or not the target system supports required functionality and, if it does not, whether it can emulate or workaround the missing functions. This procedure is fairly complicated and, due to the nonstandard nature of most UNIX systems, prone to error. The first time that you configure the software for use you should check the output from the configure script and look for anything that does not make sense for your system. A sample configure run is shown below together with an explanation of the work that is done.

A second function of the configure script is to set configuration parameters for the software. Many of these values are just default settings that can be changed after configuration through files that programs read at runtime, but some settings cannot be changed without rerunning the configure script. For example, by default the software is configured for installation in the /usr/local hierarchy; this cannot be changed without rerunning the configure script.

The configure script reads two configuration files to get configuration parameters: a site-wide configuration file that has settings that are to be applied to all systems at a particular site, and a target-specific configuration file that has settings for a specific system. Site-wide configuration files are named config.site and are automatically searched for first in any directory specified on the command line to configure with the -site option, or if that fails, in the directory in in which the configure script is located. Target-specific configuration files are named config.local and are looked for first in the top-level build directory, or, if that fails, in the directory in which the configure script is located.

NOTE: configure reads any config.site file first, and then any config.local file. This permits target-specific definitions to override site-wide definitions.

Configuration files are actually just shell scripts (written in the Bourne shell syntax) that define well-known shell variables that are used in the configuration process. For example, the following file might be used on a BSD/OS system to configure the software for installation in the /usr/contrib area and to make use of the Adobe Font Metric files that are already distributed as part of the BSD/OS 1.1 distribution:

The complete list of configuration parameters is given in the sample config.site file provided in the source distribution. Also, the sections below on ``Configuring Packages'' and ``Configuration Parameters'' have information on the most important or obscure parameters.

Finally, take note that there are two other configuration-related files that may be useful. The file named config.cache has all the configuration parameter settings that were selected the last time configure was run. This file is automatically read in by configure when it starts up to speed the configuration process. config.cache may be safely removed at any time. Cached settings are also automatically ignored if new settings are set through command line arguments to configure or through a config.local or config.site file.

The other file of interest is config.log. This file contains information and messages related to the various tests that configure does when constructing a build environment. If the configuration process fails for some reason or configure does something unexpected this file should be used to debug the problem.

NOTE: Beware that the configure script is designed to be similar to scripts generated by the GNU autoconf facility but it is not 100% compatible. Use the -help option to configure for a list of the available options.

Configuring Packages

HylaFAX uses the notion of a package to control which pieces of software are included in a build. Some packages are optional and are installed only as needed, or only if specifically requested at the time the configure script is run. Other packages may select one of several incompatible choices that must be made when the software is built. Packages can be specified in a config.site or config.local file, or by using a -with-package option when invoking configure; e.g. configure -with-AFM to request the AFM package. Most packages are automatically configured according to the characteristics of the system where HylaFAX is being built; this may not be appropriate when preparing binary distributions for multiple systems in which case they can be explicitly enabled or disabled.

Name Default Description
Adobe Font Metrics AFM=auto This package contains Adobe Font Metric files that came from the public dvips distribution. AFM files are required by the textfmt(1) and faxmail(1) programs for converting ASCII text to PostScript. The AFM files should reflect the characteristics of the fonts that are used for imaging PostScript on the fax server. However if the PostScript RIP used to image text does not come with AFM files for its fonts, then this package can be substituted with only minimal degradation in the formatting of the imaged text. By default this package is configured for installation only if font metric files do not appear to be present on the build machine.
Display PostScript RIP DPS=no Whether or not to build and install a DPS-based PostScript imager for IRIX 4.x and 5.x systems from sources present in the HylaFAX build tree. This option is intended for people building binary distributions.
Dynamic Shared Object Support DSO=auto This package controls whether or not to configure the building of Dynamic Shared Objects (DSOs) for utility routines used by both client and server applications, and for a nucleus of common code used by server applications. Use of DSOs can significantly reduce the disk space needed for the HylaFAX software. If DSOs are not used then the code is statically linked into each application that requires it. By default this package is configured only if the build system appears to suport DSOs in a way that fits into the normal build scheme. If DSO support is explicitly enabled and there is no support for using DSOs in the expected way then DSOs are not used. Beware that DSOs can only be used when the compiler and runtime system support the runtime instantiation of global C++ objects that have constructors; something that few systems support.
Getty Support GETTY=auto This package controls whether or not to configure BSD- or System V-style getty support for handling incoming data connections. By default this package is configured according to the requirements of the target system.
Ghostscript RIP GS=no Whether or not to build and install a PostScript imager from Ghostscript sources present in the HylaFAX build tree. This option is intended for people building binary distributions.
Impressario RIP IMP=no Whether or not to build and install an Impressario 2.1 plug-in DSO from sources present in the HylaFAX build tree. This option is intended for people building binary distributions.
HTML Documentation HTML=no This package contains this HTML documentation about HylaFAX. By default this package is not configured for installation. HTML documentation can be viewed directly from the source directory; otherwise all the documentation can be viewed from the main WWW site at http://www.vix.com/hylafax/. This option is intended for people building binary distributions.
PostScript RIP PS=auto This package selects which RIP to use for imaging PostScript on the server. Possible values are: gs for Ghostscript, dps for the Display PostScript-based RIP provided for IRIX 4.x and 5.x systems, or imp for a plug-in DSO for Impressario 2.1 under IRIX. By default the DPS support is selected for IRIX systems; otherwise Ghostscript is used.
Regular Expression Support REGEX=yes This package controls whether or not to use the regular expression package included with the software. On systems where there is POSIX regular expression support in the standard system library use of this package may be disabled. Note that if this package is disabled the location of the include files and library containing the regular expression support must be specified; see the REGEXINC and LIBREGEX configuration parameters.
SGI RGB Image Converter Support SGI2FAX=auto This package controls whether or not to configure the sgi2fax program that converts SGI RGB images to TIFF/F (for direct transmission as facsimile). By default this package is configured for installation only if the build system appears to have support for the SGI Image library that sgi2fax uses to read RGB images. If this package is not installed then SGI RGB images must be converted to a form suitable for transmission using some other mechanism.
System V Init Support SYSVINIT=auto This package controls whether or not to configure the System V-style support for automatically starting the HylaFAX queuer process from init(1). By default this support is configured for installation only if the target system appears to use a System V-style init (auto); i.e. the /etc/rc0.d and /etc/rc2.d directories exist.
UTMP/WTMP Support UTMP=auto This package controls whether or not system accounting work should be done using the normal utmp files and data structures or the extended utmpx facilities. By default the appropriate support is chosen based on whether or not the build system has the <utmpx.h> file (auto). Explicit support can also be chosen by setting this parameter to utmp (normal accounting) or utmpx (extended accounting).
zlib Support ZLIB=yes This package controls whether or not to use the zlib compression package included with the software. On systems where the zlib distribution has already been installed this package may be disabled. Note however that if this package is disabled the location of the include files and library for the zlib distribution must be specified; see the ZLIBINC and LIBZ configuration parameters.

Configuring the HTML Documentation

HylaFAX comes with extensive documentation written in HTML, the language used to author many documents found on the World Wide Web (WWW). These materials can be viewed at the main WWW site http://www.vix.com/hylafax/, they can be installed on a local WWW server, or they can be viewed directly from the source area. Viewing the documentation through a WWW server is preferred because the materials include links to reference manual pages that are accessed through CGI scripts, and these links will not be available when the documentation is accessed directly from the source distribution.

To configure the build environment so that it will install the HTML documentation, you need to request the ``HTML package'' when running the configure script. This is done by specifying -with-HTML as a command-line option to configure or by setting HTML=yes in a config.site or config.local file. When the HTML package is setup for installation there are four other parameters that should be defined according to local conventions:

Parameter Default Description
DIR_HTML /var/httpd/hylafax The directory where HTML materials should be installed.
DIR_CGI /var/httpd/cgi-bin The directory where CGI scripts should be installed.
CGIPATH /cgi-bin The pathname to use in HTML documents to reference scripts installed in DIR_CGI.
HTMLPATH /hylafax The pathname to use in HTML documents to reference materials installed in DIR_HTML.

(NB: the default values are suitable for the NCSA HTTP server).

Finally, to complete the installation the HTML documents must be edited to fix pathnames that are found in the HTML files. All instances of @HTMLPATH@ and @CGIBIN@ must be replaced with the values of DIR_HTML and DIR_CGI, respectively. (This was done automatically in previous versions of HylaFAX but must now be done manually.) A shell script to do this is:

There are a few other issues to consider when installing the CGI scripts:

Upgrading From FlexFAX

 If you were previously using FlexFAX beware that several things have changed in incompatible ways. The following is a list of things you should be aware of when configuring the latest distribution:

There are other issues with upgrading from FlexFAX; they are discussed in the chapter that describes setting up the server.

A Sample Configuration Session

This section shows a sample configuration session and describes the work done. The session on the left in a fixed width font with user-supplied input in a bold font. Commenttary is shown on the right in a normal or italic font or across both columns. Blank space is present in the session output where it is needed to fit comments on the page; in normal operation the output from configure does not include this white space.

This session was collected on a 486 machine running BSD/OS 1.1.

wullbrandt% mkdir fax wullbrandt% cd fax wullbrandt% ln -s /hosts/oxford/usr/people/sam/fax src A build tree separate from the source tree is used here. In fact, in this case the distribution is accessed from a read-only NFS-mounted filesystem.
wullbrandt% src/configure Configuring HylaFAX (tm) (aka FlexFAX) v3.0beta095. If configure does the wrong thing, check the file config.log for information that may help you understand what went wrong. Reading site-wide parameters from src/config.site. Fee, fie, foe, this smells like a i386-unknown-bsdi1.1 system. Note that the version and the deduced target configuration (i386-unknown-bsdi1.1) are printed. The file config.log should be checked if something goes wrong during configuration; it has output from the tests that configure does.
Using /usr/local/bin/gcc for a C compiler (set CC to override). Looks like /usr/local/bin/gcc supports the -g option. Looks like an ANSI C preprocessor. ... but __ANSI_CPP__ is not automatically defined, will compensate. Looks like /usr/local/bin/gcc supports the -M option for make dependencies. configure checks the normal shell search path for ANSI C compilers. A compiler is selected if it properly compiles a small test program. A specific compiler may be selected by setting the CC environment variable to the appropriate pathname, by supplying the parameter on the command line, e.g. -with-CC=gcc, or by setting CC in a configuration file.
Note that an ANSI C compiler is required to build the software. If a C compiler requires options to enable ANSI C compilation, these options can be specified with the ENVOPTS parameter.
Using /usr/local/bin/gcc for a C++ compiler (set CXX to override). Looks like /usr/local/bin/gcc supports the -g option. Using " -g" for C++ compiler options. Looks like an ANSI C++ preprocessor. ... but __ANSI_CPP__ is not automatically defined, will compensate. A C++ compiler is selected using a scheme similar to the one used to find a C compiler. Likewise there is a CXX parameter that can be set to explicitly select a C++ compiler.
Using /usr/bin/make to configure the software. Using ".include <file>" syntax for Makefiles. The make selected must support include files. configure can deduce several different syntaxes for specifying include files. Note that a large number of configuration parameters can be changed by editing the top-level defs file that is included by each Makefile in the distribution. A MAKE parameter can be used to control which make to use.
Using /bin/bash to process command scripts. All the HylaFAX shell scripts are written using Bourne shell syntax. The standard shell on many systems is incapable of processing these scripts so configure prefers bash to ksh to sh.
Looks like -lutil is needed for wtmp file logging. Looks like -lm is the library for math functions. Various system-specific libraries that may or may not be needed are checked for. If your system requires a library that is not automatically included it can be specified by setting the MACHDEPLIBS parameter.
Creating port.h. The port.h file is included by all the C and C++ code in the system. It includes definitions for functions and types that are missing from system include files, #defines to enable or disable system-specific functionality, and other odds and ends.
Creating port.h with necessary definitions. ... open FIFO files read-only ... use (sig_t) for signal handler type ... use (sig_t) for sigvec handler type ... use (sig_t) for sigaction handler type ... configure use of mmap for memory-mapped files ... configure use of fchown ... add function prototype for cuserid ... configure use of fchmod ... add function prototype for setutent ... add function prototype for endutent ... add function prototype for pututline ... configure use of <locale.h> (internationalization support) ... configure use of <paths.h> ... configure use of <sys/select.h> ... configure use of logwtmp (BSD-style wtmp logging) ... add function prototype for logwtmp ... configure use of logout (BSD-style utmp support) ... add function prototype for logout Done creating port.h. This file can take a long time to generate so configure creates the file only when it is needed, either because the file does not exist or because a different target or compiler is to be used. Note that running "make distclean" in the top-level directory of the build tree will remove the port.h file (along with all the other files generated by configure).
Selecting emulated library functions. Certain functions used by HylaFAX are not present on all systems but can be emulated using other system functionality. configure checks for the presence of required functions and if they are missing, will configure emulation code from the port directory to use instead. Building HylaFAX on unsupported systems may require adding to the code to the port directory.
Checking system libraries for functionality to emulate. ... emulate cuserid Done checking system libraries. If a routine must be emulated and configure does not automatically check for it, the routine name can be specified using the PORTFUNCS parameter. To add emulation support for a new function foo, create a file port/foo.c that contains the emulation code and then set PORTFUNCS=foo in a configuration file or modify the configure script to automatically check for the missing function.
Checking for TIFF support. Using TIFF include files from /usr/local/include Using pre-built TIFF library -L/usr/local/lib -ltiff Done checking for TIFF support. HylaFAX uses the TIFF library extensively. By default the TIFF library and tools are assumed to be instaled in the default location used by the TIFF distribution.
NOTE: If the TIFF library is installed as a DSO then the test done by configure will fail unless the DSO is in a well-know location or is explicitly searched for; e.g. with the LD_LIBRARY_PATH environment variable.
Checking for Dynamic Shared Object (DSO) support. Done checking for DSO support. If the DSO package is enabled (DSO=auto or DSO=IRIX), then configure will verify the system and compiler are capable of constructing DSO's in the expected way. Note that while a system may support DSO's the compiler may not be capable of generating the required position-independent code and/or the compiler may not pass the needed options through to the loader.
Selecting utility programs. configure locates various system utility programs that are used by the software. Note that absolute pathnames are selected because several scripts and programs excute with super-user privileges.
Selecting programs used during installation and operation. Looks like /usr/bin/awk should be used to process command scripts. Looks like /usr/sbin/sendmail should be used to deliver mail. Looks like /usr/bin/mkfifo creates FIFO special files. Looks like /bin/mv supports the -f option to force a move. Looks like /bin/ln supports the -s option to create a symbolic link. Done selecting programs. Several things to note: The awk program selected for use must support functions using the POSIX-style syntax (i.e. using function and not the older func keyword). configure will not select an awk program that does not support the syntax used by the awk scripts included in the distribution. Mail delivery is done using sendmail; a different mailer cannot be substituted without changing certain scripts because a number of sendmail-specific command line options are used.
Selecting default configuration parameters. The remainder of the work done by configure involves setting up configuration parameters that are mainly used during the operation of the fax software. These parameters can be set during configuration or, in most cases, they can be set through runtime configuration files.
Using uid uucp and gid dialer for controlling access to fax stuff. Using uid bin and gid bin for installing programs. Using LSB2MSB bit order for your i386 cpu. Looks like you need BSD getty support. Looks like /usr/libexec/getty is the program to exec for a data call.
Looks like /bin/vgetty as the program to exec for a voice call. Looks like /bin/egetty as the program to exec for an extern call. Looks like you use binary-style UUCP lock files. Looks like UUCP lock files go in /var/spool/uucp. Looks like font metric information goes in /usr/contrib/lib/flexfax/afm. Looks like the gs imager package should be used. Looks like /usr/contrib/bin/gs is the PostScript RIP to use. Looks like manual pages go in /usr/local/man. Looks like manual pages should be installed with bsd-nroff-gzip-0.gz. The egetty and vgetty programs are not part of HylaFAX; they are ``hooks'' for developers to integrate programs that implement voice-oriented capabilities.
HylaFAX configuration parameters are: [ 1] Directory for applications: /usr/local/bin [ 2] Directory for lib data files: /usr/local/lib/fax [ 3] Directory for lib executables: /usr/local/lib/fax [ 4] Directory for system apps: /usr/local/bin [ 5] Directory for manual pages: /usr/local/man [ 6] Directory for HTML documentation: /usr/local/doc/fax [ 7] Directory for spooling: /var/spool/fax [ 8] Directory for font metrics: /usr/contrib/lib/flexfax/afm [ 9] Directory for uucp lock files: /var/spool/uucp [10] Uucp lock file scheme: binary [11] PostScript imager package: gs [12] PostScript imager program: /usr/contrib/bin/gs [13] Manual page installation scheme: bsd-nroff-gzip-0.gz [14] Default page size: North American Letter [15] Default vertical res (lpi): 98 [16] Location of getty program: /usr/libexec/getty [17] Location of voice getty program: /bin/vgetty [18] Location of sendmail program: /usr/sbin/sendmail [19] Location of TIFF tools: /usr/local/bin Are these ok [yes]? At this point you can interactively modify any of the displayed parameters. Hitting a carriage return or typing yes will accept the current parameters. Typing one of the numbers displayed along the left hand side causes configure to prompt for a new value of the specified parameter. Typing anything else causes configure to prompt for a new value for each parameter. In general hitting carriage return will accept the current value and typing anything that is unacceptable will cause a help message to be displayed. See below for descriptions of the parameters.
Creating defs from src/defs.in Creating rules from src/rules.in Creating Makefile from src/Makefile.in ...stuff deleted... Setting up make dependency files. Done. Once parameters are setup configure generates all the files that depend on these parameters. Note that certain files may or may not be created based on the selection of optional packages and/or the functions supported by target system.

Configuration Parameters

 This section gives a brief description of the less obvious configuration parameters. Consult the distributed config.site for a complete list of parameters. The list here is sorted alphabetically.

NOTE: The default setting for most configurations parameters is usually correct. Be especially careful about enabling or overriding parameters that control workarounds for system bugs; certain problems can cause server processes to go into infinite loops!

Note that HylaFAX is composed of client and server applications. Client applications are programs that normal users invoke to send facsimile, query the status of facsimile servers, etc. Server applications are programs that reside only on the machine where the fax modems are present.

Parameter Description
AROPTS The options passed to ar when creating an archive. Note that configure will automatically check to see if ar supports an s to create a symbol table instead of using ranlib.
CONFIG_ABORTBUG On some systems the logic used by the server processes to poll for messages on a FIFO special file while actively doing work can cause the process to go into an infinite loop. Setting this parameter to yes causes the server processes to not poll for messages. Enabling this workaround means that the faxgetty process will not recognize messages to abort a facsimile while it is being received.
CONFIG_BADEXECVEPROTO On some systems the prototype function declaration for the execve system call is wrong (it does not list certain parameters as const). Setting this parameter to yes causes the software to work around this problem.
CONFIG_BADEXECVPROTO On some systems the prototype function declaration for the execv system call is wrong (it does not list certain parameters as const). Setting this parameter to yes causes the software to work around this problem.
CONFIG_BADGETOPTPROTO On some systems the prototype function declaration for getopt is wrong (it does not list certain parameters as const. Setting this parameter to yes causes the software to work around this problem.
CONFIG_BADSELECTPROTO On some systems the prototype function declaration for select passes sets of file descriptors as int* instead of fd_set*. Setting this parameter to yes causes the software to assume the int* form is required.
CONFIG_FIFOBUG Whether or not to enable a workaround for a kernel bug that causes select system calls to return prematurely after a process closes the ``client side'' of a FIFO special file. Setting this parameter to yes causes server processes to close and reopen FIFO special files after each received message. Note that aside from the additional overhead incurred in the server processes, this problem can also cause client programs to be temporarily unable to reach a server process. To minimize this possibility, the client code tries to reach a server process up to 5 times before giving up; this can introduce noticeable delays in applications such as faxstat.
CONFIG_NOREOPEN Whether or not to reopen the tty device that a modem is connected to after raising and lowering the DTR signal (to reset the modem). This is done because on some systems lowering DTR causes the device to be placed in an unusable state. It may be desirable to disable this action however; for example when a modem is connected to an Ethernet-based terminal server. Setting this parameter to yes causes the modem to be reopened after reset. By default this parameter is set according to the target system.
CONFIG_NOSTDINDUP On some systems, if the standard output is redirected to be the same as the standard input, then the stty program will emit a warning message. This is necessary for some older systems because it is the only way to force stty to change parameters on a tty device that is not the controlling tty. Setting this parameter to yes causes the ondelay program to not set stdout to stdin. Enabling this workaround can break the faxaddmodem program; it should be used only on systems where stty supports the -f option to select a tty device other than the controlling tty.
CONFIG_OPENFIFO The mode to use when opening a FIFO special file in a server process. Normally this should be O_RDONLY, but on some systems this must be O_RDWR to avoid kernel bugs that cause select system calls to return prematurely after a process closes the ``client side'' of a FIFO. By default this parameter is set according to the target system.
CONFIG_SELECTBUG On some systems where the FIFO select bug (see above) exists the select system call may return bits set in the read, write, and exception masks even if they were not requested; this in turn can cause the Dispatcher code to abort. Setting this parameter to yes causes the Dispatcher to ignore any bits set in bit vectors returned by select if the bits were not requested. Enabling this workaround adds additional overhead to each server process.
CONFIG_SOCKARGLENTYPE On some systems the type of call-by-reference parameters that specify the size of variable-length buffers in socket-related calls is wrong (the type is something other than int*). This parameter can be set to the C type that should be used for length parameters; e.g. ``unsigned long''; otherwise int is assumed. Setting this parameter incorrectly should result in compilation errors.
CONFIG_TIOCMBISBYREF Whether to pass the argument to the TIOCMBIS ioctl by value or by reference. On most systems the value is passed by reference; consult termio(7) for your system if you are unsure how your system works. Setting this parameter to yes is the default and generates code for passing the argument by reference.
CONFIG_WINSZHACK On some systems the TIOCWINSZ ioctl is defined, but its use requires the inclusion of two non-standard files. Setting this paramter to yes causes the inclusion of these files.
CXXFILE The options to the C++ compiler required to get the compiler to process a file with a .c++ suffix as C++ source code. configure automatically sets this parameter to "-x c++" for gcc and to "-+" for the IBM xlC compiler under AIX.
DEFVRES The default vertical resolution in lines/inch that clients should use for submitted facsimile. Choices are 98 and 196.
DIR_AFM The directory where client applications should find Adobe Font Metric (AFM) files. These files are used by various HylaFAX programs when converting text to PostScript.
DIR_BIN The directory where client applications should be installed; by default this is /usr/local/bin.
DIR_CGI The directory where CGI scripts used by the HTML-based HylaFAX documentation should be installed; by default this is /var/httpd/cgi-bin (usually appropriate for the NCSA HTTP server).
DIR_HTML The directory where HTML-based HylaFAX documentation should be installed; by default this is /var/httpd/htdocs/hylafax (usually appropriate for the NCSA HTTP server).
DIR_LIBDATA The directory to install data files that are required by client applications; by default this is /usr/local/lib/fax.
DIR_LIBEXEC The directory to install executable programs that are invoked by other applications and not from the command line (e.g. the textfmt program invoked by sendfax to convert text to PostScript when submitting a fax job); by default this is the same as DIR_SBIN.
DIR_LOCKS The directory in which to create UUCP lock files.
DIR_MAN The top-most directory of the manual area where client/server manual pages should be installed.
DIR_SBIN The directory where system applications such as servers should be installed; by default this is /usr/local/sbin.
DIR_SPOOL The directory in which the HylaFAX server spooling area should be setup; by default this is /var/spool/fax.
DSODELAY When DSO's are built, the option to specify to CC and/or CXX to note that a library should be loaded only as needed. This option is used to delay the loading of the TIFF library for applications that may use it infrequently.
DSOOPTS When DSO's are built, the options to specify to CC and/or CXX to create a DSO.
DSOSUF When DSO's are built, the filename suffix for a DSO. If this is set to "a" then statically linked archives are used.
ENVOPTS Options to pass to CC and CXX to force ANSI C compilation.
FAXGID The group ID to use for the fax user; by default this is selected according to the target system.
FAXUID The user ID to use for the fax user; by default uucp.
FILLORDER The order of bits in a byte on the server machine; either LSB2MSB or MSB2LSB. This is normally selected according to the target system.
GCOPTS Special options to pass the C compiler. If this parameter is set, then configure may append other options to this list.
GCXXOPTS Special options to pass the C++ compiler. If this parameter is set, then configure may append other options to this list.
INSTALL The pathname of the install program to use. Note that this program must emulate the command line interface used by the IRIX install program.
LIBMALLOC Whether or not to use -lmalloc in building the software. By default (auto) configure will probe the system to see if the library is present; if it is then the software will be configured to use it when building. Other possible values are: yes and no to enable and disable use, respectively. On systems that support DSOs it may be important to disable the use of -lmalloc to avoid conflicts with the normal memory alocation routines present in the standard C library.
LIBPORT The pathname of the library that holds code to emulate missing system functionality. Normally this parameter is set by configure based on whether or not emulation code is required for the target.
LIBSUN Whether or not to use -lsun in building the software. By default (auto) configure will probe the system to see if the library is present; if it is then the software will be configured to use it when building. Other possible values are: yes and no to enable and disable use, respectively.
LIBREGEX The command line parameter(s) to use to link the library containing regular expression support. This parameter is set by default to reference the software included in the distribution.
LIBTIFF The command line parameter(s) to use to link against the TIFF library. This parameter is set by default to the default installation location used by the TIFF software distribution.
LIBZ The command line parameter(s) to use to link against the zlib library. This parameter is set by default to reference the software included in the distribution.
LLDOPTS Extra command line options passed to CC and CXX when linking an executable. This option is usually set only when DSO support is enabled (to force the executable to search for the HylaFAX-specific DSO's in non-standard locations in the filesystem.)
LOCKS A specification of the default type of UUCP lock files to use. This parameter is usually one of ascii, binary, -ascii or +ascii; consult the config(4F) manual page for a description of the UUCPLockType configuration parameter.
MACHDEPLIBS Target-dependent libraries that should be used when linking applications. Note that if this parameter is specified configure will append to the list of libraries.
MAKECXXOVERRIDE A special parameter used by configure when constructing Makefiles. This parameter is required when compiling the software with the SunPRO C++ compiler; it works around limitations in the SunPRO compilation environment.
MAKEDEPINCLUDE The keyword used to specify the inclusion of a make dependency file when constructing Makefiles. This parameter is set to MAKEINCLUDE if make dependendcies are to be constructed by the software; otherwise it is set to # so that no make dependency rules are included (and used).
MAKEDSOINCLUDE The keyword used to specify inclusion of a file containing rules for building DSO's. This parameter is set to MAKEINCLUDE if DSO's are to be built; otherwise it is set to # so that nothing is included.
MAKEINCLUDE, MAKELQUOTE, MAKERQUOTE The syntax used to specify an include file for make; e.g. @MAKEINCLUDE@ @MAKELQUOTE@file@MAKERQUOTE@. These parameters are normally deduced by configure depending on the capabilities of the make program to use.
MANSCHEME The scheme to use when preparing and installing manual pages. Schemes are constructed according to:
    <organization>-<formatting>-<compression>[-<suffix>]
where: <organization> is either bsd for BSD-style section organization (e.g. file formats in section 5) or sysv for System V-style organization (e.g. file formats in section 4). <formatting> is either nroff to force installation of formatted materials (using nroff) or source to get the nroff source installed. <compression> is either the name of a program to compress the manual pages (gzip, compress, pack) or cat for uncompressed data. <suffix> is either the file suffix to convert installed pages to (e.g. 0.gz for gzip-compressed pages under BSD) or strip to force the normal ".4f" suffix to be converted to ".4" (or ".5" if using the BSD organization). If no -<suffix> is specified then filenames are not converted when they are installed.
PAGESIZE The default page size that client applications will use for submitted facsimile. Page sizes are specified by name and checked against the pagesizes database installed in the DIR_LIBDATA directory. See also pagesizes(4F).
PATH_DPSRIP The absolute pathname of the Display PostScript-based imager program.
PATH_EGETTY The absolute pathname of suitable getty program to exec to deduce the type of an inbound call. Note that this parameter must be set correctly before the software is built; there is no mechanism for doing this through a runtime configuration file. This program is not part of HylaFAX; it is provided as a ``hook'' for developers to integrate voice capabilities.
PATH_GETTY The absolute pathname of suitable getty program to exec to handle an inbound data call. Note that this parameter must be set correctly before the software is built; there is no mechanism for doing this through a runtime configuration file.
PATH_GSRIP The absolute pathname of the Ghostscript-based imager program. Beware that this must be a version of the gs program that includes the tiffg3 device driver.
PATH_IMPRIP The absolute pathname of the Impressario 2.1-based imager program available for IRIX 6.2 (and beyond) systems.
PATH_SENDMAIL The absolute pathname of the sendmail program on the server machine; sendmail is used by HylaFAX to post mail messages for a variety of reasons.
PATH_VGETTY The absolute pathname of suitable getty program to exec to handle an inbound voice call. Note that this parameter must be set correctly before the software is built; there is no mechanism for doing this through a runtime configuration file. This program is not part of HylaFAX; it is provided as a ``hook'' for developers to integrate voice capabilities.
PORTFUNCS A list of non-standard functions that should be emulated. Normally this list is constructed by configure based on checks it does. If this parameter is set, configure will append to the specified list.
PROTOTYPES Options that should be passed to the C compiler to force it to check for function prototype mismatches. This parameter should not be needed because ANSI C compilers should do this automatically.
REGEXINC The pathname of the directory containing include files for the regular expression package. By default this parameter is set to reference the package included with this distribution.
SCRIPT_SH The absolute pathname of the shell program to use when building HylaFAX and to use to execute certain command scripts. This shell must support the Bourne shell command syntax. Beware that many versions of bash have bugs in them that make them unsuitable for use.
SETMAKE If make does not automatically set $MAKE to the name of the make program to invoke for subdirectories, then configure will create an explicit definition. If this parameter is set, then it will be used instead.
SHDLIBC A special library to use in place of the standard -lc implicitly provided by CC and/or CXX.
SIGHANDLERTYPES The type signatures to use when checking for the correct type for a signal handler. If this parameter is set then configure will check these types before it checks a builtin list of well-known values.
SYSGID The group ID to use for installing non-setgid programs; by default this is chosen according to the target system.
SYSUID The group ID to use for installing non-setuid programs; by default bin is used.
TIFFBIN The pathname of the directory where the TIFF software distribution tools have been installed.
TIFFINC The pathname of the directory where the TIFF software include files have been installed.
ZLIBINC The pathname of the directory containing include files for the zlib distribution. By default this parameter is set to reference the package included with this distribution.

Troubleshooting Build Problems

Most compilation problems are because the configure script did not properly setup the software for building. If you have problems compiling the software on a supported system check the output from configure and the contents of the port.h file generated by configure to make sure it makes sense. Another byproduct of the configuration procedure is the config.log file that is found at the top of the build tree. This file contains information about the tests done by the configure script; it should also be studied to check for problems.

The most common problem encountered during building, which is frequently not recognized until later when a program does not work correctly, is when the system include files are lacking proper ANSI C function prototypes. In particular beware of compilation warnings about ``passing an object as an argument to a function'', this usually means that a function was defined without a function prototype and then a C++ object was passed through the interface as an argument. For example, if the C library strchr function is declared as

instead of the expected then the C++ compiler will not know to do the implicit cast of the first parameter to a const char*; almost certainly causing problems. Unfortunately many older systems do not have system include files that include ANSI C function prototype declarations; if this is true of your system then you are unlikely to get HylaFAX to build correctly.

System-specific Guidance

 This section contains some build-related issues that are dependent on the operating system installed on the build machine. The information included here is by no means exhaustive; it reflects feedback from users accumulated over multiple HylaFAX versions and/or operating system releases.

AIX Guidance

 To use the IBM xlC C++ compiler you must have a version that supports the -+ option so that filenames with a .c++ extension are processed properly by the compiler.

Under at least AIX 4.2 some socket-related function declarations have been changed to use non-standard types. To workaround compilation problems the CONFIG_SOCKARGLENTYPE configuration parameter should be specified to reflect the appropriate type of the call-by-reference length parameter passed to accept, getpeername, and getsockname.

BSD/OS Guidance

Beware that the standard BSD/OS distributions place many files and applications in non-standard locations. This can cause confusion when HylaFAX is installed because the old applications distributed with BSD/OS may be accidentally run and do the wrong thing. Under BSD/OS 2.1 the following config.local file may be used to configure a build tree that installs over top of the standard BSD/OS distribution of HylaFAX.

Note that you will also need to specify the location of the TIFF software because the version distributed with BSD/OS 2.1 is too old to use.

Dell SVR4 Guidance

 On some releases <sys/mkdev.h> includes static functions with non-ANSI C definitions; these must be manually corrected before building the software. (The GNU gcc installation procedure attempts to correct this file but does not.)

The ttymon program is executable only by root; this may cause the configure script to not select it as the getty program that is started up for inbound data calls. To work around this problem override the default selection through the interactive prompts or by creating a config.local file that explicitly sets the PATH_GETTY configuration parameter.

FreeBSD Guidance

FreeBSD 2.0 does not include the file <osfcn.h>. If the software does not compile without this file a copy can be obtained from the GNU libg++ distribution: ftp://prep.ai.mit.edu/pub/gnu/libg++*.tar.gz, libg++-2.6.2/libg++/src/osfcn.h.

HP-UX Guidance

 Under HP-UX 9.05 the standard make incorrectly processes VPATH; either use gmake or configure the software to be built directly in the source tree.

Some versions of HP-UX define the select system call with parameters that are of type int*; if so set CONFIG_BADSELECTPROTO=yes to work around the problem.

Some versions of HP-UX have the include file <utmpx.h> but do not support the extended accounting facilities defined by this file. This confuses the configure script; to work around the problem set UTMP=utmp when configuring the build environment.

Linux Guidance

Under various versions of Linux; when linking with the -g option; if the linker complains about needing libc.so.4, then it is necessary to setup symbolic links in /usr/lib so that: libg.a -> libc.a and libg.sa -> libc.sa.

Some recent versions of Linux come setup so that when C++ programs are compiled the standard C functions strchr and strrchr (and possibly others) have multiple definitions based on the types of their arguments. This overloading causes compilation problems because HylaFAX assumes the ANSI C definition which specifies a single definition for these functions. To workaround this problem either correct the include file <string.h> or re-install gcc and/or libg++ (the standard distributions do not cause problems).

IRIX Guidance

Older versions of the SGI C++ compiler do not correctly handle nested types. If configure complains that the compiler is unsuitable for use or if the software does not build correctly verify that you have an up to date version of the compiler.

When building the software to use DSOs it may be necessary to set LIBMALLOC=no to avoid conflicts between the memory allocation routines in the standard C library and those in -lmalloc.

Under IRIX 5.3 /bin/sh has a bug that causes the faxsetup script to run correctly but terminate with an error. It may be preferrable to set SCRIPT_SH=/bin/ksh though it is not necessary.

Solaris Guidance

Under (at least) Solaris 2.3 the standard make does VPATH processing incorrectly for files passed to the mkdepend script (the last file in the list is not converted to a pathname relative to the source directory); this causes lots of msgs that can be safely ignored.

Some versions of Solaris include an old version of the TIFF library with the OpenWindows software. This can cause problems when running the configure script unless the LD_LIBRARY_PATH environment variable is explicitly set to reference the location of the newer TIFF library DSO or the path is explicitly set with a -R flag in the LIBTIFF configuration parameter.

Ultrix Guidance

[Ed: this information comes from Tom Lislegaard.]

Extensive work is required to get the software built and working. The following comments apply to at least Ultrix 4.4. These notes relate to building and running HylaFAX Version 3.0 with gcc-2.6.3 and libg++-2.6.2.

Two header files cause problems: termios.h and sys/socket.h.

termios.h defines tcsetattr, tcgetattr, etc in terms of macros that map to ioctl's; this causes problems with the configure script. As the real functions are present in libc, working around this problem is just a matter of bringing the include file up to date. (When compiling with GNU gcc the file to patch is normally /usr/local/lib/gcc-lib/mips-dec-ultrix4.4/2.6.3/include/sys):

123,125d122 < #if !defined(_POSIX_SOURCE) < #define tcsetattr(fildes,action,termios_p) \ < ioctl(fildes,action,termios_p) 127,133d123 < #define tcgetattr(fildes,termios_p) \ < ioctl(fildes,TCGETP,termios_p) < #else < extern int tcsetattr(); < extern int tcgetattr(); < #endif < 147,152d136 < #if !defined(_POSIX_SOURCE) < #define tcdrain(fildes) \ < ioctl(fildes,TCSBRK,-1) < #else < extern int tcdrain(); < #endif 161,166d144 < #if !defined(_POSIX_SOURCE) < #define tcflush(fildes,queue) \ < ioctl(fildes,TCFLSH,queue) < #else < extern int tcflush(); < #endif 176,181d153 < #if !defined(_POSIX_SOURCE) < #define tcflow(fildes,action) \ < ioctl(fildes,TCXONC,action) < #else < extern int tcflow(); < #endif 183,189d154 < /* < * Get input and output baud rates. < */ < #if !defined(_POSIX_SOURCE) && !defined(_XOPEN_SOURCE) < #define OBAUD (CBAUD << 16) < #define cfgetospeed(termios_p) \ < (((termios_p)->c_cflag & OBAUD) >> 16) 191,198c156,160 < #define cfgetispeed(termios_p) \ < ((termios_p)->c_cflag & CBAUD) < #else < extern speed_t cfgetospeed(); < extern speed_t cfgetispeed(); < extern int cfsetispeed(); < extern int cfsetospeed(); < #endif --- > extern int tcsetattr(int, int, const struct termios*); > extern int tcgetattr(int, struct termios*); > extern int tcdrain(int); > extern int tcflush(int, int); > extern int tcflow(int, int); 199a162 > extern int tcsendbreak _PARAMS((int, int));

/usr/include/sys/socket.h needs to be protected against multiple inclusion:

2a3,4 > #ifndef _SOCKET_ > #define _SOCKET_ 237a240 > #endif /* _SOCKET_ */

Many of the tools provided with Ultrix are outdated, functionally crippled, or just buggy. Affected here are sh, make, expr, and sed.

configure must be run by ksh; e.g.

There is no hope for using /bin/sh, it does not support shell functions. The good news is that the current /bin/ksh handles all the scripts as well, so it is not necessary to install bash; simply use

A recent version of GNU make must be used (I have used version 3.67).

A replacement expr program is found in the GNU Shell Utilities package; it is needed in place of the default system version. Likewise for sed; I have used GNU Version 2.05.

The syslogd and printf programs are not available on Ultrix. On a host running only client software (no local modem) these may be ignored. On a server machine these are required.

The standard syslog support can not handle the HylaFAX server processes (or any other modern software for that matter). It should be replaced with a newer syslogd. Several alternatives are available, the stuff I have used can be found at ftp://gatekeeper.dec.com:/pub/DEC/jtkohl-syslog-complete.tar.Z.

(A note here: on my system I have done a complete replacement, including putting new syslog functions in my libc.a. This means that I have not tried to build with the port/syslog.c support included with HylaFAX; though it should be equivalent).

How to setup a HylaFAX server and prepare it for use. HylaFAX table of contents.

Sam Leffler / sam@engr.sgi.com. Last updated $Date: 1996/08/26 19:40:31 $.