This appendix lists the files associated with the Faximum Messaging Server and provides a short explanation for each.
The /etc/faximum.conf file provides the master configuration files used by all of the FMS components. For detailed information on the contents of this file, please see "/etc/faximum.conf File" on page 105.
The fms start-up script is used to start the daemons associated with the FMS software (see "Daemons, Starting" on page 31).
The fmsinet script is used to configure the network parameters on the system that is to run the FMS software. It is normally only run once when the system is booted. (See "Daemons, Starting" on page 31
The /opt/faximum/fms directory is the default installation directory for the Faximum Messaging Server. The /opt part may be changed during the installation to suit the layout of your particular disk structure. You may also change this directory after installation (see "Directory Locations" on page 51). All of the directories listed below are relative to this path name.
bin/
The bin directory contains executable programs that can be usefully run apart from their use within FMS.
asciitiff
This file is a link to either fsasciitiff or pkasciitiff (see below).
fsasciitiff
This program is used to convert text (ascii) files into TIFF (i.e. fax) format. This version of the program uses the X11 Font Server to provide the necessary font bitmaps.
pkasciitiff
This program is used to convert text (ascii) files into TIFF (i.e. fax) format. This version of the program uses the font bitmaps found in the font/ directory (see below).
tiffcat
This utility concatenates separate TIFF-F files into a single multi-page TIFF file.
tiffhp
This utility converts TIFF-F files into HP PCL print streams suitable for printing faxes on printers that understand the HP PCL printer control language.
tiffls
This utility lists the directory information from a TIFF-F file. This utility can be used to analyse the structure of a TIFF file.
tiffps
This utility converts TIFF-F files into PostScript print streams suitable for printing faxes on printers that support PostScript.
tifftiff
This utility reformats TIFF-F files into a form appropriate for faxing.
convert/
The convert directory contains the conversion scripts used by the Faximum Messaging Server to process text and attachments into TIFF-F (i.e. fax) format.
ascii
The ascii script handles all text attachments.
mswin
The word script is used to handle Microsoft Word attachments.
tiff
The tiff script is used to handle TIFF-F files.
font/
This directory contains the files that provide the bitmap font information used by the pkasciitiff program (see above). On systems with the X11 Font Server this directory will not be populated by the installation script since the X11 fonts are preferable to the bitmap fonts used by pkasciitiff.
http/
This directory contains the programs executed through the FMS web server as well as the directory that contains the FMS manual.
fmsadmin.cgi
The fmsadmin module generates the web pages that comprise the FMS administration interface (see "Faximum Messaging Server, Administering a" on page 43).
manual/
This subdirectory of the http directory contains the HTML and PDF files that comprise the on-line documentation for FMS.
swiiftfwg.cgi
The swiiftfwg module provides the gateway between received faxes stored on the server and the user's web browser. The details of how this module is used is covered in xxyyzz.
The name swiiftfwg comes (a) from our high-end SWIIFT product, SWIIFT standing for Suite of Web and Internet/Intranet Fax Tools, and (b) from the letters of Fax/Web Gateway. The original swiiftfwg module being part of the SWIIFT product before being packaged as part of FMS.
lib/
The lib directory contains many of the executables that make up the daemons and other executables related to the Faximum Messaging Server.
checkfms
This program will attempt to connect to the FMS swiiftefg daemon and report if this was successful. This utility can be used to verify if the network has been properly configured (although it will not verify the FMS domain name) and if the swiiftefg daemon is running properly.
cleanspool
This script is normally run daily by the cron process and it performs various housekeeping functions such as truncating log files.
diagnostics
This program will collect information about your FMS system that can be used by technical support personnel to diagnose problems with your system. See xxyyzz.
dispatch
This program is run by faxcico after a fax is received and handles the routing of the fax. If DID or ISDN routing is enabled then dispatch will look up the user database to determine to whom the received fax ought to be routed. If DID or ISDN is not available, then the fax will be placed in the general delivery fax inbox.
faxcico
The faxcico module is the workhorse of the fax server component of the FMS. It is run by faxgetty to handle incoming faxes and by faxsched to send outgoing faxes.
faxgetty
The faxgetty module is run by the init daemon from the inittab file and is responsible for handling incoming calls on the fax modem and for determining if the incoming call is a data or fax call.
faxlisten
The faxlisten module is started by the fms script (see above) and is responsible for handling incoming calls on Dialogic GammaLink fax boards.
faxsched
The faxsched daemon manages to fax queue and determines when to send the next fax request. It monitors the fax queue (normally /var/spool/faximum/destinations) and invokes faxcico as necessary to send each request.
fms-httpd
The fms-httpd daemon is the FMS web server. By shipping an integral web server, Faximum avoids the problems associated with having users configure their own web server to interface with the swiiftfwg and fmsadmin modules.
mergemon
This utility is used to monitor SCO Merge (on FMS systems where SCO Merge is being used to handle MS Windows proprietary file attachments. See xxyyzz for more information.
modemtab
This file contains information used by the faxcico module to recognise different types of fax modems and to adjust its behaviour accordingly.
newpasswd
This program can be used by FMS system administrators who wish to manipulate the users file directly (see "Users File" on page 119). This program will take a password string and produce the SHA-1 hashed version used in the users file by FMS.
permchk
This program will check the ownership and permissions of files associated with the FMS product and, optionally, fix any problems that are detected.
permchk.list
This is the data file used by permchk to determine what the ownership and permissions ought to be for the files that make up the FMS product.
sendfax
The sendfax module accepts a control file from swiiftefg and prepares the actual fax request. Note that sendfax is intended for use only by swiiftefg and that the direct use of the sendfax module is not supported.
start.sh
The start.sh shell script will start the daemons associated with the Faximum Messaging Server (with the exception of faxgetty which is started by the init daemon). The daemons started include the FMS http server (fms-httpd) and faxsched.
swiiftefg
The swiifefg (SWIIFT Email/Fax Gateway) module is the key component that handles the email-to-fax function for the FMS. Swiiftefg contains a full ESTMP email server as well as the code needed to manage the conversion of attachments to a fax message to be passed to sendfax.
swiiftfeg
This module (SWIIFT Fax/Email Gateway) is used by the dispatch program and the swiiftwfg component to convert a received fax file (i.e. TIFF-F file) into a form that can be sent by email.
tifffix
This utility is used internally by FMS to perform minor restructuring of TIFF-F files when they are being exchanged with Dialogic GammaLink fax boards.
By default, the files that contain the information on the configuration of the Faximum Messaging Server are found in the /var/faximum directory. By separating the configuration files from the (static) executable and data files in the /opt/faximum directory makes updating the software much easier.
During installation you may select another directory (other than /var) in which to place this directory.
All of the path names listed below are relative to /var/faximum.
coversheet/
This directory that contains the files that describe the format of the cover sheets generated by FMS when sending faxes.
dev/fax-line-1
This file contains the configuration information for the first fax modem line. Files for the second and subsequent fax lines (if there are more than one) are named fax-line-2, etc.
httpd-config
This file provides the configuration information used by the FMS web server (the httpd daemon described above)
mime-types
This file contains the information needed by the Faximum Messaging Server to determine how to handle files that are attached to email messages passed to the FMS. For more information on the contents of this file please see "Mime Types File" on page 116.
user-file
This file contains the detailed information on every user authorised to use the Faximum Messaging Server. For more information on the contents of this file please see "Users File" on page 119.
By default, the files that contain the information on fax requests in progress (or waiting to be sent) as well as the log files for the Faximum Messaging Server are found in the /var/spool/faximum directory.
During installation you may select another directory (other than /var/spool) in which to place this directory. After installation you can relocate this directory by following the instructions in the section "Directory Locations" on page 51.
All of the path names listed below are relative to /var/spool/faximum.
acct
This is the accounting log which contains an entry for every time the fax modem takes a phone line off-hook (see also "Accounting Log, Viewing" on page 27).
destinations
This directory contains subdirectories that contain the actual fax requests waiting to be sent.
deststatus
This directory contains the files used by FMS to record the status associated with active destinations.
devstatus
This directory contains the files used by FMS to record the status associated with the fax modems.
inbox
This directory contains subdirectories used to store received faxes before delivery to users.
log
This is the system event log which records all events of significance in the operation of the FMS daemons and components (see also "System Log, Viewing" on page 80).
seqno
This file is used to record the sequence number used by the FMS components.