APPENDIX A Inventory
This appendix lists the files associated with the Faximum Messaging Server and provides a short explanation for each. Files marked with an asertisk (*) are part of the FMS+PLUS product (and not FMS).
Many of the executable files located in the bin and lib directories are further documented in APPENDIX D on page 113.
The 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/opt/faximum/faximum.conf File" on page 97.
This file contains the software activation key that you need to enable the software.
The faximum start-up script is used to start the daemons associated with the FMS software (see "Daemons, Starting and Stopping" on page 31). This is actually a link to the /opt/faximum/etc/init.d.script file. Depending on the version of Linux or UNIX you have installed FMS on, these links may appear in other /etc directories such as /etc/rc.d/init.d, /etc/rc2.d, /etc/init.d/rc2.d, etc. and etc.
The /opt/faximum/ directory is the default installation directory for the Faximum Messaging Server. You may change this directory after installation. All of the directories listed below are relative to this path name.
The bin directory contains executable programs that can be usefully run apart from their use within FMS.
This file is a link to either fsasciitiff or pkasciitiff (see below).
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.
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).
This utility concatenates separate TIFF-F files into a single multi-page TIFF file.
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.
This utility lists the directory information from a TIFF-F file. This utility can be used to analyse the structure of a TIFF file.
This utility converts TIFF-F files into PostScript print streams suitable for printing faxes on printers that support PostScript.
This utility reformats TIFF-F files into a form appropriate for faxing.
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.
The ascii script handles all text attachments.
The word script is used to handle Microsoft Word attachments when the optional Windows File Convert Daemon has been installed and configured.
The tiff script is used to handle TIFF-F files.
This directory contains the files that provide the bitmap font information used by the pkasciitiff program (see above).
This directory contains the programs executed through the FMS web server as well as the directory that contains the FMS manual.
The FMS Windows Print Driver installation package. This file, signed by Faximum Software Inc., is the installation program for the FMS Windows Print Driver.
The fmsadmin module generates the web pages that comprise the FMS administration interface (see "Faximum Messaging Server, Administering a" on page 42).
A shell script used to implement the Help buttons on the fmsadmin web pages.
This subdirectory of the http directory contains the HTML and PDF files that comprise the on-line documentation for FMS.
The swiiftfwg module implements the Fax/Web Gateway. With the FMS product this implements the ability to view the fax cover sheet using a web browser. On FMS+PLUS is enables users to view and manage faxes stored on the server.
The lib directory contains many of the executables that make up the daemons and other executables related to the Faximum Messaging Server.
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.
This program will collect information about your FMS system that can be used by technical support personnel to diagnose problems with your system. See "Sending Your Support Provider Essential Information" on page 83.
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.
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.
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.
This script is normally run daily by the cron process and it performs various housekeeping functions such as truncating log files.
The faxlisten module is started by the fms script (see above) and is responsible for handling incoming calls on Dialogic GammaLink fax boards.
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.
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.cgi and fmsadmin.cgi modules.
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.
This file contains information used by the faxcico module to recognise different types of fax modems and to adjust its behaviour accordingly.
This program can be used by FMS system administrators who wish to manipulate the users file directly (see "Users File" on page 107). This program will take a password string and produce the SHA-1 hashed version used in the users file by FMS.
This program will check the ownership and permissions of files associated with the FMS product and, optionally, fix any problems that are detected.
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.
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.
The swiiftefg (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.
This module (Fax/Email Gateway) is used by the fmsdispatch program and the swiiftfwg component to convert a received fax file (i.e. TIFF-F file) into a form that can be sent by email.
By default, the files that contain the information on the configuration of the Faximum Messaging Server are found in the /etc/opt/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.
All of the path names listed below are relative to /etc/opt/faximum.
This directory that contains the files that describe the format of the cover sheets generated by FMS when sending faxes.
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.
This file provides the configuration information used by the FMS web server (the httpd daemon described above)
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 104.
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 107.
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/opt/faximum directory.
All of the path names listed below are relative to /var/opt/faximum.
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 28).
This directory contains subdirectories that contain the actual fax requests waiting to be sent.
This directory contains the files used by FMS to record the status associated with active destinations.
This directory contains the files used by FMS to record the status associated with the fax modems.
This directory contains subdirectories used to store received faxes before delivery to users.
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 75).
This file is used to record the sequence number used by the FMS components.
Faximum Technical Support