Package hylafax+

An enterprise-strength fax server

http://hylafax.sourceforge.net

HylaFAX(tm) is a enterprise-strength fax server supporting
Class 1 and 2 fax modems on UNIX systems. It provides spooling
services and numerous supporting fax management tools.
The fax clients may reside on machines different from the server
and client implementations exist for a number of platforms including
windows.

File Formats (Section 5)
doneq.5f
Files in the doneq directory specify completed transmission job requests. These files are created by hfaxd(8C), when submitting a job on behalf of sendfax(1) or...
hosts.hfaxd.5f
The ASCII file etc/hosts.hfaxd in the HylaFAX spooling area specifies the hosts and users that are permitted to access services through the hfaxd(8C) process...
hylafax-config.5f
HylaFAX uses a configuration file for the central queueing agent and for each facsimile modem attached to a machine. These files contain information about the...
hylafax-info.5f
The info subdirectory in the HylaFAX spooling area holds information about the capabilities and status of devices that have been called. One file exists for...
hylafax-log.5f
Files in the log directory in the HylaFAX spooling area contain logging/tracing information about transmit and receive sessions. One file exists for each...
hylafax-server.5f
HylaFAX is a system for sending and receiving facsimile. It supports queued transmission and asynchronous reception of facsimile. Ancillary programs are invoked...
hylafax-shutdown.5f
If the file etc/shutdown is present it describes when a HylaFAX server is to be shutdown and may contain a descriptive message to return to clients explaining...
pagermap.5f
The file etc/pagermap (by default) is used by the SNPP support in hfaxd(8C) to map pager identifiers specified with the PAGE directive to IXO/TAP or SMS service...
recvq.5f
Facsimile received by HylaFAX are placed in the recvq subdirectory. Each facsimile document is stored as a single Class F Tagged Image File Format (TIFF) file.
sendq.5f
Files in the sendq directory specify transmission job requests. These files are created by hfaxd(8C), when submitting a job on behalf of sendfax(1) or...
status.5f
Files in the status directory in the HylaFAX spooling area contain status information about each running server. Files are named according to the modem being...
tsi.5f
The HylaFAX configuration parameter QualifyTSI specifies whether or not the identity of a calling facsimile machine should be checked against an access control...
xferfaxlog.5f
The file etc/xferfaxlog contains information about inbound and outbound activities. The file contains one line per inbound facsimile document or outbound job...
System Administration (Section 8)
choptest.8c
choptest is a program for testing the page chopping support in the HylaFAX software (specifically, in the faxq(8C) program). choptest analyzes a TIFF/F (TIFF...
cqtest.8c
cqtest is a program for testing the copy quality checking support in the HylaFAX software (specifically, in the faxgetty(8C) program). cqtest takes a TIFF/F...
faxabort.8c
faxabort sends a message to a HylaFAX faxgetty(8C) process servicing modem telling it to abort any active receive operation. The specified modem can either be...
faxaddmodem.8c
faxaddmodem is an interactive shell script that does the necessary setup work to configure a modem for use by the HylaFAX software. To enable use of the...
faxadduser.8c
faxadduser creates a new user for HylaFAX services, updating appropriate permission files (see hosts.hfaxd(5F)). Note that users may also be added through the...
faxanswer.8c
faxanswer sends a message to the HylaFAX faxgetty(8C) process servicing modem telling it to answer the telephone. This is useful, for example, when a modem is...
faxconfig.8c
faxconfig sends messages to a HylaFAX server process telling it to install new values for one or more configuration parameters. These new values are maintained...
faxcron.8c
faxcron is a command script that does routine upkeep tasks in a HylaFAX spooling directory hierarchy. This script is intended to be invoked from cron(8C) on...
faxdeluser.8c
faxdeluser deletes all entries with the supplied username from the HylaFAX permissions database (see hosts.hfaxd(5F)). Note that users may also be deleted...
faxgetty.8c
faxgetty is the HylaFAX server program that listens for incoming phone calls and either handles each call directly or hands it off to an appropriate program. In...
faxlock.8c
faxlock sends a message to a HylaFAX faxgetty(8C) process servicing modem telling it to change its state to LOCKWAIT The specified modem can either be the name...
faxmodem.8c
faxmodem sends a message to the HylaFAX queuer process faxq(8C) telling it that the specified modem is ready for use and informing it about its fax-related...
faxmsg.8c
faxmsg is a utility program used by other HylaFAX client programs. It is not intended to be run directly.
faxq.8c
faxq is the central queueing agent for HylaFAX. One (and only one) faxq process is normally running at all times. faxq is responsible for scheduling, preparing...
faxqclean.8c
faxqclean is a program that processes completed HylaFAX jobs and expunges unreferenced document files. This program is intended to be invoked by cron(8C) on...
faxquit.8c
faxquit sends a message to a HylaFAX server process telling it to quit operation. If modem is specified, the faxgetty(8C) process servicing the specified modem...
faxrcvd.8c
bin/faxrcvd is the command script invoked by the facsimile server whenever a facsimile is received. It is designed to be customizable by the administrator...
faxsend.8c
faxsend is the program that implements the facsimile transmission protocol for the HylaFAX system. faxsend is invoked by the faxq scheduler process for each...
faxstate.8c
faxstate sends a message to the HylaFAX faxgetty(8C) process servicing modem telling it to use the specified state when notifying the HylaFAX scheduler that a...
hfaxd.8c
HylaFAX client-server protocol server
hylafax.8c
HylaFAX is a sophisticated enterprise-strength fax package for class 1 and 2 fax modems on unix systems.
jobcontrol.8c
The HylaFAX configuration parameter JobControlCmd specifies the script that is used to apply per-job controls on job characteristics such as the time-of-day to...
lockname.8c
lockname is a program invoked by faxaddmodem and probemodem to generate a UUCP lock filename according to SVR4 conventions. It is not intended to be run...
mkcover.8c
bin/mkcover is the command invoked by the facsimile server when a continuation cover page is required for an outbound job that is about to be retried. It...
notify.8c
bin/notify is the command script invoked by the facsimile server to notify a user about the status of an outbound job. It is designed to be customizable by the...
ondelay.8c
ondelay is a program invoked by faxaddmodem and probemodem to configure a modem device for use by those programs. It is not intended to be run directly.
pagesend.8c
pagesend is the program that implements the IXO/TAP and the UCP transmission protocol for the HylaFAX system. pagesend is invoked by the faxq scheduler process...
pollrcvd.8c
bin/pollrcvd is the command script invoked by the HylaFAX server whenever a facsimile is received as a result of a polling operation. It is designed to be...
probemodem.8c
probemodem probes a modem attached to a serial line and reports the results of certain commands.
ps2fax.8c
ps2fax takes POSTSCRIPT input and generates a TIFF Class F image file suitable for facsimile transmission. It is usually invoked by the HylaFAX scheduler...
recvstats.8c
recvstats is a command script that prints a summary of the HylaFAX accounting statistics for received facsimile. The statistics can be sorted using one of...
tagtest.8c
tagtest is a program for testing the “tag line” support in the HylaFAX server. tagtest takes a TIFF/F (TIFF Class F) file and generates a new TIFF/F file that...
tsitest.8c
tsitest is an interactive program for the testing of the TSI access control list (ACL) used by the faxgetty(8C) server processes to screen incoming facsimile...
wedged.8c
bin/wedged is the command script invoked by the facsimile server when a modem is deemed to be in an irreparable state and requires operator intervention. This...
xferfaxstats.8c
xferfaxstats is a command script that prints a summary of the HylaFAX accounting statistics for transmitted jobs. The statistics can be sorted using one of...