®
-f from Provides information to identify the sender of the fax on the cover sheet (if one is specified in the style). May be repeated up to three times in order to provide the sender's name, title, and department. Default value is taken from the environment variable FAXFROM.
-m message Provides the text of the message to be placed on the cover sheet (if one is specified in the style).
-M messagefile
Provides the name of the file that contains the message to be placed on the cover sheet (if one is specified in the style). If both -m and -M are specified then the -m message will appear before the -M message.
-o company
Provides information to identify the recipient's company (organisation) on the cover sheet (if one is specified in the style).
-r subject Provides the information for the subject line on the cover sheet (if one is specified in the style).
-s style Specifies the style (from the style database, see Chapter 2 of the Reference Manual) to use for this transmission (as a whole). Mandatory. If no style is specified, and no cover sheet information (options -f, -m, -M, -o, -r, or -t) is provided, then a default style that does not generate a cover sheet will be used. Otherwise a cover sheet will be generated. Default value is taken from the environment variable FAXSTYLE.
-S style Specifies the style (from the style database, see Chapter 2 of the Reference Manual) to use for the following attachments (files). If no style is specified for the first attachment, then the page length, resolution, and overlay specification for the style of the fax as whole (see -s) will be used. If no style is specified for the second and subsequent attachments, then the page length and resolution (but not overlay) for the style of the fax as a whole will be used. The style specified by the -S option stays in effect for all subsequent attachments until overridden by another -S option.
-t to Provides information to identify the recipient of the fax on the cover sheet (if one is specified in the style). May be repeated up to three times in order to provide the recipient's name, title, and department.
-T filetype Specifies the type for the following attachments (files). If no type is specified for an attachment, then submitfax will examine the first few bytes to determine the file type (see submitfax(C)). The type specified by the -T option stays in effect for all subsequent attachments until overridden by another -T option. Valid values include ASCII, TIFF, PCL, and POSTSCRIPT (case is not significant). Note that support for the PCL and PostScript file types requires that the appropriate option be installed.
Note that Faximum ELS does not support the account or class of service databases. On ELS systems the -a and -c options will be ignored.
EXAMPLES
In the following examples the backslash (`\') at the end of the line is an indication that the following line ought to be typed as part of the same line (that is to say the command is too long to fit on one line and has been broken up into multiple lines).
ls -l / | fxm 926-8182
fxm 1-604-926-8182 -m "New Price List" /tmp/message
fxm 926-8182 -t Bob -t Janitor -f Harry -f Supervisor \
/docs/price.list
fxm 555.1212 -t "Sally Smith" -M /docs/messagefile
SEE ALSO
submitfax(C)
Appendix E.
NAME
mfax - manual fax send/receive
SYNOPSIS
mfax mode [ options ] file1 file2...
DESCRIPTION
mfax can be used to manually send or receive files from a fax modem, bypassing the normal Faximum spooler. It can be used when other devices are being used to control the phone line (such as voice applications).
MODES
tx transmit fax
rx receive fax
OPTIONS
-d Debug
-f device Select fax device
-p phone-number
Sets number to dial. Transmit without specifying a phone number implies immediately pick up the phone and send transmit tones.
-t file-type
Set file type for conversion. The default file-type is tiff. The -t option can specify any file type found in ~fax/convert. This option can be specified multiple times on the command line. All files are converted prior to initiating a call.
-v Verbose
-w Wait for before connect
For receive, a device must be specified if more than one fax device exists. On transmit, mfax will use the first available device if no device was explicitly specified with the -f option. You can use a symbolic device name (e.g. fax-line-1), an absolute path (e.g. /dev/tty2a), or a line type (e.g. @default) just as in the device specification in fax control files.
On transmit, the -t option must be used when the file(s) to be transmitted are not already in TIFF-F format. mfax uses the same mechanism as sendfax for file conversion. A missing phone number is legal; mfax will assume the number was dialled by some other method (e.g. manually) and will attempt to start a fax session without dialling.
Received data is stored in a TIFF-F format file.
SEE ALSO
sendfax(C)
NAME
new... - create a new ISAM database file
SYNOPSIS
new... [ -h ] [ -i filename ] [ -q ] [ -s separator ] database-file
DESCRIPTION
The new... programs convert ASCII files into an ISAM database file of the specified name. There is a new... program for each type of database (i.e. newaccount, newaction, newclass, newcompany, newdatabase, newdial, newdispatch, newpeople, newprinter, newscanner, newsrdest , newsrfile, newsrreq, and newstyle).
OPTIONS
-h Writes a table to standard error that describes the type, length, and meaning of each field in the database. Note that the character string widths reported in this table are one less than the storage actually used, since the null byte is not included in the length reported.
-i filename
Indicates that the input is to come from the named file instead of standard input. Each line of input is taken as a single record in the database. The fields within a single line are separated by the separator character (see below).
-q Specifies that warning messages are to be suppressed (i.e. quiet mode).
-s separator
Changes the character used to separate fields from each other. The default field separator is `:'.
SEE ALSO
dump... (C)
Chapter 2 of the Faximum Reference Manual
NAME
pcltiff - render and convert PCL-4/5 to TIFF-F
SYNOPSIS
pcltiff [ options ] files
DESCRIPTION
pcltiff converts a PCL-4/5 file into a raster image stored in a TIFF file.
If the -o option is not used to name an output file, the output file is named by taking the input file name and adding .tif. If the filename already ends in a "." extension, then the extension is replaced with .tif.
No input file or a file with the name `-' implies standard input.
pcltiff is the generic name for the two PCL interpreters. Depending on the options purchased with your system you will find pcltiff linked to either pcl4tiff or pcl5tiff. The primary advantage of PCL-5 is the availability of scalable fonts and special effects such as font rotation.
OPTIONS
-a Appends to an existing TIFF file (otherwise overwrites existing file). The file is created if it does not already exist.
-h Produces high (fine) resolution output (204 d.p.i. horizontally and 196 d.p.i. vertically). This is the default.
-l Produces low (standard) resolution output (204 d.p.i. horizontally and 98 d.p.i. vertically).
-o file Uses the named file as the TIFF output file.
-O overlay-file
Uses the named file (which must be a TIFF image in either standard or fine resolution) as the letterhead overlay. If the overlay file contains only one TIFF image, this image is overlayed on every page rendered by asciitiff. If the overlay file contains more than one TIFF image, the first image is overlayed on the first page rendered by asciitiff, and the second overlay file image is overlayed on every subsequent page rendered by asciitiff.
-P page-number
Changes asciitiff's idea of the current page number, thus affecting which overlay TIFF page is overlayed. For example, asciitiff -O ovfile -P 2 ... causes asciitiff to overlay the second page of ovfile on every page rendered by asciitiff. This option only makes sense when used with the above -O option and with a multi-page overlay file.
-s size Sets the size of the page to be created. The value may be suffixed by i to indicate inches (the default), c for centimeters, or p for pixels.
-t Trims trailing whitespace from the bottom of each page.
-v Enables verbose output.
LIMITATIONS
In the interests of performance and cost, the PCL-5 interpreter does not implement the entire PCL-5 control language. In particular, the control sequences related to macros, the print model, and HP-GL graphics are not implemented.
Note also that because of the large number of fonts supported, the PCL-4 and PCL-5 interpreters do not support partial font specification using font selection priority. It is recommended that fonts be selected by specifying all important font characteristics (i.e. symbol set, spacing., pitch, height, style, stroke weight, and typeface).
FILES
/usr/fax/font/pcl
font files
SEE ALSO
convert(C)
Available fonts are listed in Appendix B.
NAME
pstiff - render and convert PostScript to TIFF
SYNOPSIS
pstiff [ options ] files
DESCRIPTION
pstiff converts a PostScript file into a raster image stored in a TIFF file. In addition to supporting a number of options, pstiff also handles a number of imbedded commands that affect its operation.
If the -o option is not used to name an output file, the output file is named by taking the input file name and adding .tif. If the filename already ends in a "." extension, then the extension is replaced with .tif.
No input file or a file with the name `-' implies standard input.
Normally this program is called by the shell program /usr/fax/convert/ps (see convert(C)).
OPTIONS
-a Appends to an existing TIFF file (otherwise overwrites existing file). The file is created if it does not already exist.
-d state Debug after init, where state in one of the following: alloc, exec, error, dict, read, stack, frame device, color, save, proc, fill render, stroke, font, init, full, all.
-D state Debug before init, where state in one of the following: alloc, exec, error, dict, read, stack, frame device, color, save, proc, fill render, stroke, font, init, full, all.
-f file Names the startup file used for interpreter initialisation. The default is ~/.postscript.
-i Read input from standard input.
-h Produces high (fine) resolution output (204 d.p.i. horizontally and 196 d.p.i. vertically). This is the default.
-l Produces low (standard) resolution output (204 d.p.i. horizontally and 98 d.p.i. vertically).
-o file Place rendered output in file. This option implies -a. A missing output file causes pstiff to replace the input file extension (if any) with .tif and use this file for output. A missing input and output file sends output to pstiff.tif.
-O file The overlay file option can be used to specify the name of a TIFF file to be overlayed on each page after it has been rendered. If the overlay file contains only one TIFF page, this page is overlayed on every page rendered by pstiff. If the overlay file contains more than one TIFF page, the first page is overlayed onto the first page rendered by pstiff, and the second overlay file page is overlayed on every subsequent page rendered by pstiff.
-p Pack procedure bodies.
-P pageno The page number option modifies which overlay TIFF page is overlayed by changing pstiff's idea of what the current page number is. For example, pstiff -O ovfile -P 2 ... causes pstiff to overlay the second page of ovfile on every page rendered by pstiff. This option makes sense only when used with the -O option and a multi-page overlay file.
-s name Specifies startup command
-t Trim trailing whitespace (i.e. no-pad) from each output page.
FILES
/usr/fax/font/pcl
font files
SEE ALSO
convert(C)
Available fonts are listed in Appendix B.
NAME
sendfax - low-level FAX request handler
SYNOPSIS
sendfax [ options ] [ files ]
DESCRIPTION
sendfax queues fax requests for delivery by faxcico. Files not already in TIFF format will be converted.
This program provides programmers (as well as Faximum itself) with a low-level API. Since all outgoing faxes must be spooled and scheduled, it is not possible to have a more direct connection with the FAX system than is provided by this program.
OPTIONS
-d Turn on debug messages.
-e script Use the next argument as the list of newline-terminated commands for sendfax.
-j Prints the jobname on standard output. Jobname is a four letter sequence number.
-k Delete the files provided as arguments after they have been read. The files will not be deleted if any errors are detected by sendfax.
-m Mail back error messages. Normally, error messages are displayed on the user's terminal. With this option, if any errors occur, they are collected in a file and mailed to the user.
-q Quiet mode. All job progress messages are suppressed.
-r Do not notify the fax scheduler when the fax requests are queued. This delays possible delivery of fax requests until faxsched does a queue run, or another sendfax is run without this option. Normally faxsched examines the queues once every minute or whenever a fax line becomes idle.
sendfax reads input from a command-line script (if the -e option is used), from any file names listed on the command line, or from standard input if no other sources of input are specified. Each line of input is interpreted as a command, or data for the most recent command. A line containing only an end ends input data for the most recent command. Commands are:
file Specifies the files to be sent and the conversions required. Following the file command is a list of lines each containing: a tagname; the path to the file; file type and conversion options;, and a list of options.
The tagname is used elsewhere to identify the file. Its name is arbitrary but must be unique.
The file type specifies the conversion required. For example, ascii will convert a standard ascii file to a standard-resolution fax. Conversion options (such as resolution and page length) may also be specified. For example, "ascii -h -s 14" will generate a fine-resolution fax paginated to legal size paper.
See the directory /usr/fax/convert for a list of all the supported conversions and refer to the manual page convert(C) for information on the conversion options.
Only two options are supported: nocopy and delete. sendfax normally makes its own copies of files to send in the spool area. nocopy will prevent copying of a file if the file requires no conversion (i.e. type tiff with no conversion options) and is readable to faxcico. delete will delete the file when it has been copied to the spool area. No files will be deleted if any part of the sendfax request fails.
default Sets defaults for each fax request. The default section consists of a list of name = value pairs terminated with an end statement. For every fax request that follows, this default list will be copied to the list of request parameters. Any parameter explicitly listed in a fax request will override any default. This option is intended as a means of specifying parameters common to every fax request.
fax Submits a fax request. The fax command requires a single argument specifying a unique name for the destination (usually the fully qualified telephone number with no imbedded white space). This name will be used as the name of the queue directory in the spool directory (usually in /usr/spool/fax/destinations) and therefore ought to have 14 or fewer characters.
Following this command, there should be a list of name = value pairs specifying the parameters for this particular fax request. Except for the list of data files, all parameters are copied verbatim into the spooled control file for this request. Any parameter starting with data-file is assumed to be a data file for transmission. The value part of this data file parameter must be a tagname from a preceding file command. This tagname is replaced by the absolute path name of the (possibly converted and copied) file to be transmitted.
preview [preview-program]
Previews files to be transmitted. An optional argument specifies the path to the preview program; tiffdisplay is the default preview program. An end terminated list of tagnames, one per line, follows. The absolute path names of the files named by these tagnames are given as command-line arguments to the preview program. A non-zero exit status from the display program indicates to sendfax that no faxes are to be submitted and no further processing is required. This would normally occur if the user wished to cancel the request after previewing it.
print Prints a fax request. This command requires a list of arguments containing the shell command to execute and a list of arguments for that command. The argument $data-file1 will be replaced by the path names of the end terminated list of tagnames that follow the print command.
background
Tells sendfax to continue operating in the background so that the foreground task can continue operation. This keyword is usually placed after the preview section so that the printing (if any) and scheduling of the fax transmission can continue in the background. The background command (unlike the previous commands) is not followed by a line containing end.
signal Causes sendfax to send a signal to a specified process. The signal number is the first argument and the operating system process id the second.
The fax config file (see config(F)) may also contain defaults for many of these fields. The per request control file always overrides the global defaults contained in ~fax/config.
Valid name = value pairs follow. Note that only the device and data-file... parameters are required. All others are optional. If the parameter value contains white space, it must be quoted. The value component may be quoted using the same syntax as the shell, and may include any of the following escape sequences: \b (backspace), \e (escape), \f (formfeed), \n (newline), \r (carriage return), \t (tab), and nnn (character with octal value nnn).
For example:
name = value
name = "value value value"
name = "This \" string is funny"
abort-time = number
This specifies the time when the fax request is to be abandoned, at which point mail is sent to the originator reporting the problem and a message is placed in the system log file. The time value may be specified in one of three formats. A value of the form @seconds specifies an absolute time in seconds from the epoch (the standard format for the return value from the time system call). The form +seconds specifies a number of seconds since the request was submitted to sendfax. The form !seconds specifies a number of seconds since the request was first eligible to be sent (i.e. satisfied the limitations of the eligible-date and time-to-send parameters), regardless of whether a line was available at that time.
account-number = string
Any information provided will be copied verbatim into the accounting log file. By convention this string is of the form: "<billing code> <person> <company>"
alternate-count = number
This value specifies the maximum number of attempts that are to be made using the primary telephone number before trying the secondary telephone number. Once alternate-count attempts have been made, the system will try the secondary and primary telephone numbers alternately until successful or until one of the time or retry limits is reached.
alternate-device = device name
This value specifies the fax line and telephone number(s) to use when alternate-count attempts have been made using the primary telephone lines (see the device parameter below for more information on the format of this value).
banner = string
The string specified will be placed at the top of every transmitted page. Strings of the form $p will be replaced with the current page number, and $t will be replaced with the total number of pages in the FAX. Strings that start with a % symbol will be passed directly to the strftime(I) routine, which replaces the string with date and time information.
batch = yes/no
Specifies if a request can be batched with other requests that are queued for the same destination.
completion-program = program-pathname
Can be called when a fax request is no longer considered for transmission because either it was successfully transmitted, or faxsched/faxcico will not attempt to retry at a later date. This program requires two arguments: the path to the control file and a brief message explaining why the request will no longer be considered for transmission. For security reasons, the completion-program must have fax's home directory (usually /usr/fax) as the first part of its path name. It is the responsibility of completion-program to dispose of the request control file.
data-file1 = string
This specifies the tagname (see the file section above) of the first file to be sent (similarly for data-file2, data-file3...).
data-queued = date/time-string
Date a fax request was queued. Defaults to current date/time.
device = device name
This specifies the name of the FAX line to use and the actual string of digits to dial. This is the primary (fax line and) telephone number to use. (See alternate-count and alternate-device). The format is fax line name:telephone number or fax line name:telephone number:delay.
The fax line name may be one of the following: the name of the fax line configuration file in the /usr/fax/dev directory; the name of the device special file (in /dev); or @ followed by the line-type to use (faxcico will use any entry in /usr/fax/dev that has the specified line-type and that is idle).
The telephone number is the string of digits to dial (possibly with the delay characters `,' and `;'). The delay is the time in minutes from when the request was submitted until the system considers using the specified line.
If the system supports more than one phone line, there may be more than one fax line name:telephone number on the same line (separated by blanks, with the entire list in double quotation marks). The list is scanned from left to right for the first idle line.
eligible-date = number
This parameter specifies (in seconds since the epoch) the earliest (date and) time when this request may be considered for transmission. This is used to postpone transmission of a request until some later time and date. Note that delaying the FAX until a specified telephone discount period is usually done using the time-to-send parameter.
filter-value = value
This parameter specifies the filter value to use on the FAX modem for this transmission. If not specified, then the default filter value from the device configuration file (in the directory /usr/fax/dev) will be used. Not all fax modems use or support a filter value, and the purpose and range of valid values varies. Please refer to your fax board/modem's documentation for further information.
notify = yes/no
If set to `yes', the user who submitted the request will receive E-mail upon successful completion of the transmission (unsuccessful transmissions always result in E-mail).
priority = number
This specifies the priority of the fax request. If there is more than one fax request to send, the fax scheduler will choose the one with the numerically higher priority value.
reschedule-time = number
This parameter specifies the time at which this request is to be handed to the rescheduler (/usr/fax/lib/resched) for possible escalation to more expensive telephone lines. Note that no such program is provided as part of Faximum; if this option is used, the user must provide the resched program.
retry-coversheet = tag
This allows a user to specify a coversheet to be used only if a fax is partially transmitted and must be restarted. As with data-file, tag must be the tagname of a file listed in the file section of the input script.
retry-delay = number
This specifies the delay (in minutes) between redial attempts. If not specified, the default delay is taken from the system configuration file (~fax/config).
retry-limit = number
This parameter places an absolute maximum limit on the number of attempts that the fax scheduler will make to send this fax in the event that the telephone number does not answer or is busy. If not specified, the default limit is taken from the system configuration file (~fax/config).
sent-by = username
User name to be used for E-mail and accounting.
suspend-completed-requests = yes/no
This causes successfully transmitted request control files to be renamed from cf... to ff....
suspend-failed-request = yes/no
This causes failed requests to be suspended (i.e. the control file prefix is changed from cf... to sf.... and is no longer considered by faxsched for transmission). Renaming the sf... file cf... will cause faxsched to reconsider the fax for transmission.
time-to-send = number
This specifies the interval during which attempts may be made to send this FAX (expressed as three time-intervals: the first applies Monday through Friday, the second on Saturday, and the third on Sunday). (Example: "1800-2400 1800-2400 0800-2400"). This is used to ensure that a FAX is only sent during certain telephone discount periods.
tsi = string
This specifies the transmitting station identification string. The string ought to be the fully qualified (country code, etc.) telephone number of the incoming FAX line for the company sending the fax.
tsia = string
This specifies the alphanumeric transmitting station identification string. Some fax boards support an alphanumeric identification string in addition to the standard numeric TSI.
EXAMPLE
This is an example of a minimal sendfax file that faxes a single ASCII file (which is deleted after being queued to send).
file
body /tmp/fcvr.BAAa10927 ascii delete
end
fax 16135551212
device = fax-line-1:16135551212
data-file1 = body
end
The following example shows the use of several sendfax command options.
file
cover /tmp/fcvr.BAAa10927 ascii delete
body1 /usr/doe/images/lit.tif tiff nocopy
body2 /tmp/graph.ps "ps -h -s 14"
end
preview
cover
body1
body2
end
background
print "tiffps $data-file1 | lp -dlaser"
cover
body1
body2
end
default
banner = "Company Inc. +1 234 567 9876 %c Pg $p/$t"
tsi = "1 234 567 9876"
priority = 99
retry-count = 30
retry-delay = 1
completion-program = /usr/fax/lib/myscript.sh
time-to-send = "1800-0800 1800-0800 0000-2400"
end
fax 16135551212
device = @ddd:16135551212 @fx1:5551212
data-file1 = cover
data-file2 = body1
data-file3 = body2
end
fax 16049268182
device = fax-line-1:16049268182
retry-delay = 10
data-file1 = cover
data-file2 = body1
data-file3 = body2
end
FILES
/usr/fax/config
system configuration file (for defaults)
/usr/fax/convert/*
input file conversion programs
/usr/fax/dev/*
fax line configuration files
/usr/spool/fax/destinations/*
spool area
/usr/spool/fax/log
fax log file
/usr/spool/fax/acct
fax accounting file
SEE ALSO
asciitiff(C), convert(C), faxsched(C), transmitfax(C), strftime(I)
Appendix E.
NAME
submitfax - high-level fax applications interface
SYNOPSIS
submitfax [-d] [-k] [-m] [-v] commandfile
DESCRIPTION
submitfax accepts a high-level request for a fax transmission and converts it (by reference to the configuration and database files) into a low-level request that is handed off to sendfax. Submitfax is a replacement for transmitfax(C) and ought to be used in preference to transmitfax for all future integration work.
-d Enables debug mode which will generate additional output describing the internal operation of the program.
-k Deletes the commandfile after processing is complete.
-m Mails errors to the current user instead of sending them to standard error.
-v Enables verbose mode which will generate additional output describing the operation of the program.
The commandfile contains a list of parameter definitions of the form parameter = value, one per line. The value may optionally be enclosed in double quotation marks, which are required only if the value starts with a blank or contains a double quotation mark.
The following parameters are currently supported (they may appear in any order in the commandfile):
account The name of the account (from the account database) to use for any destination that has no destination-specific account (the account database provides information used for the accounting of fax calls). If this parameter is not specified, the value in the environment variable FAXACCOUNT (if any) will be used. Optional (but one of account, dest_accountn, or FAXACCOUNT must be specified if accounting is required by your system).
class The name of the class (from the class database) to use for any destination that has no destination-specific class (the class database controls the scheduling of the fax transmission). If this parameter is not specified, the value in the environment variable FAXCLASS (if any) will be used. Optional (but one of dest_classn, class, or FAXCLASS must be set).
dest_account1
The name of the account (from the account database) to use for this destination (the account database provides information used for the accounting of fax calls). If this parameter is not specified, the value for the parameter account or in the environment variable FAXACCOUNT (if any) will be used. See the account parameter above for more information.The same parameter for subsequent destinations is named dest_account2, dest_account3, etc. Optional (but one of account, dest_account1, or FAXACCOUNT must be specified if accounting is required by your system).
dest_altfax1
The alternate telephone number of the destination fax, used if the primary number (dest_faxn) is not successful within the number of attempts specified in the class database. See dest_fax1 (below) for information on the required format. The same parameter for subsequent destinations is named dest_altfax2, dest_altfax3, etc. Optional.
dest_class1 The name of the class (from the class database) to use for this destination (the class database controls the scheduling of the fax transmission). If this parameter is not specified, the value for the parameter class or in the environment variable FAXCLASS (if any) will be used. See the class parameter above for more information.The same parameter for subsequent destinations is named dest_class2, dest_class3, etc. Optional (but one of dest_class1, class, or FAXCLASS must be set).
dest_cc1 The list of people who have also received this fax (note, this is an information field only and does not cause the fax to be sent to other destinations). This information is only for the cover sheet, if present. The same parameter for subsequent destinations is named dest_cc2, dest_cc3, etc. Optional.
dest_company1
The name of the company to which this fax is addressed (to be placed on the cover sheet, if present). The same parameter for subsequent destinations is named dest_company2, dest_company3, etc. Optional.
dest_dept1 The department of (or other identifying information about) the person to whom this fax is addressed (to be placed on the cover sheet, if present). The same parameter for subsequent destinations is named dest_dept2, dest_dept3, etc. Optional.
dest_fax1 The telephone number of the destination fax. If intelligent dialling has been enabled and this number does not consist of four components, then the country code and (if necessary) the local area code will be added to provide the four required components (country code, area code, exchange, and number). Intelligent dialling is available only with Faximum PLUS.
The same parameter for subsequent destinations is named dest_fax2, dest_fax3, etc. At least dest_fax1 is required. If any other dest_ parameters are specified for the second (or subsequent) destinations, then a dest_faxn must also be specified. (In other words, one may not specify dest_company2 unless dest_fax2 is also specified.) Intelligent dialling is available only with Faximum PLUS.
dest_name1 The name of the person to whom this fax is addressed (to be placed on the cover sheet, if present). The same parameter for subsequent destinations is named dest_name2, dest_name3, etc. Optional.
dest_time1 The time to delay the fax until. See the time parameter for more information. The same parameter for subsequent destinations is named dest_time2, dest_time3, etc. Optional.
dest_title1 The title of (or other identifying information about) the person to whom this fax is addressed (to be placed on the cover sheet, if present). The same parameter for subsequent destinations is named dest_title2, dest_title3, etc. Optional.
file_delete1
Indicates whether the file that contains the first attachment to this fax is to be deleted once it has been converted to fax format. Subsequent deletion parameters are named file_delete2, file_delete3, etc. Permitted values are yes or no. Optional. Default value is no. If specified, then the corresponding file_namen parameter must be specified.
file_name1 The pathname of the file that contains the first attachment to this fax. Subsequent attachments are named file_name2, file_name3, etc. Optional.
file_style1 The style to use for the first attachment to this fax (see also the style parameter below). The style for subsequent attachments are named file_style2, file_style3, etc. Optional. If specified, then the corresponding file_namen parameter must be specified. If not specified, then the value from the style parameter or the FAXSTYLE environment variable will be used.
file_type1 The file type of the first attachment to this fax (this controls the conversion program used to convert this file into fax format). Supported values include ASCII, TIFF, PCL, and POSTSCRIPT (case is not significant). Note that support for the PCL and POSTSCRIPT types requires that the appropriate option be installed. The type for subsequent attachments are named file_type2, file_type3, etc. Optional. If specified, then the corresponding file_namen parameter must be specified. If not specified, then the file itself will be examined and the file type determined by an examination of the first few bytes of the file (TIFF files start with the distinctive TIFF header tag; PCL files must start with an ESC escape sequence; PostScript files must start with the two-character sequence `%!', preceded optionally by white space; everything else is considered to be ASCII).
from_dept The department of (or other identifying information about) the person sending this fax (to be placed on the cover sheet). Optional.
from_name The name of the person sending this fax (to be placed on the cover sheet). If this parameter is not specified, the value in the environment variable FAXFROM (if any) will be used. Optional.
from_title The title of (or other identifying information about) the person sending this fax (to be placed on the cover sheet). Optional.
mailaddr The e-mail address to use for notification (see the notify parameter below). Optional. If not specified e-mail will be sent to the name in the environment variable FAXMAILADDR. If this variable is not set, then e-mail will be sent to the login name (as returned by the getlogin library call) associated with the user who ran submitfax.
message The actual text of the coversheet message (to be placed on the cover sheet). See also messagefile below. Optional.
messagefile The path name of the file that contains the text of the coversheet message (to be placed on the cover sheet). See also message above. Both message and messagefile may be specified, in which case the message precedes the text in the messagefile on the cover sheet. Optional.
notify Enables e-mail notification of successful transmissions (unsuccessful transmissions always cause e-mail notification. See mailaddr parameter above for information on e-mail addressee. Permitted values are yes or no. Optional. Default value is no.
preview Specifies that the fax ought to be previewed on the display before being transmitted. Only supported when the standard-output is connected to a console display adapter or the TERM environment variable starts with wy160 or wyse160. If the user cancels the fax during the preview operation (by pressing CTRL-C) then the fax will not be sent. If more than one destination has been specified, only the cover sheet and attachments for the first destination will be previewed. Permitted values are yes or no. Optional (default is no).
print Specifies that the fax ought to be sent to the printer before being transmitted. It is possible to specify any or all of the cover sheet (COVER), attachments (FILES or ATTACHMENTS), or confirmation (CONFIRM). The case of the keywords is not important. For example, print = Cover + Confirm.
The confirmation print-out consists of a reduced-size image of the first page of the fax along with information confirming the successful transmission of the fax.
To support previous software, the values No and Yes are also supported (yes is equivalent to Cover + Files).
If more than one destination has been specified, only the cover sheet and attachments for the first destination will be printed (confirmations, if requested, will be printed for each destination). If yes, then the printer parameter (below) must be specified. Optional (default is no).
printer The name of the printer (from the printer database) to use to print the fax (the printer database specifies the command to use to access a printer on your UNIX system). Required if the print parameter (above) is set to yes.
signature The path name of the file that contains the TIFF image of the sender's signature (to be placed on the cover sheet, if present). Optional.
subject The subject of (or other identifying information about) the fax (to be placed on the cover sheet). Optional. If not specified the value of the environment variable FAXSUBJECT will be used (if any). Optional.
style The name of the style (from the style database) to use for the cover sheet and the fax as a whole (the style database controls things like the page length, resolution, letterhead overlay, etc.). If this parameter is not specified, the value in the environment variable FAXSTYLE (if any) will be used. Required.
time The earliest time to send a fax for any destination that has no destination-specific time. Permitted values include any string that specifies a time and/or date. Time may be specified in 24-hour notation, either with an h suffix or a colon as punctuation (e.g. 2300h or 23:00); or using a.m./p.m. notation (e.g. 4:30pm). Date may be specified using month names or numbers. In the case of ambiguous specifications (e.g. is 5/7 May 7th or July 5th?) the order of the day and month number will be taken from the Date Input Format specified in the system configuration settings. Special English words are also recognised (e.g. midnight, noon, etc.). Optional.
Note that Faximum ELS does not support the account or class of service databases. On ELS systems the account, dest_accountn, class and dest_classn options will be ignored.
EXAMPLE
This is an example of the minimal submitfax commandfile that faxes a single ASCII file (the account parameter need not be specified if accounting is not required).
file_name1 = /tmp/document
style = No Coversheet (Fine)
account = overhead
class = Rush (Highest Cost)
dest_fax1 = 1 (604) 926-8182
The following example shows the use of several submitfax parameters.
from_name = Jane Doe
from_title = President
from_dept = ACME Cement
notify = yes
mailaddr = jane@acme.com
subject = New Price List
messagefile = /docs/cover.letter
signature = /usr/jane/fax/signature
style = No Coversheet (Fine)
account = overhead
class = Rush (Highest Cost)
dest_fax1 = 1 (604) 926-8182
dest_name1 = Bert Smith
dest_title1 = Senior Buyer
dest_dept1 = Purchasing
dest_company1 = AJAX Construction
dest_time1 = midnight
file_name1 = /docs/pricelist
file_type1 = PostScript
file_style1 = Company Letterhead
FILES
/usr/fax/config system configuration file (for defaults)
/usr/fax/convert/* input file conversion programs
SEE ALSO
asciitiff(C), convert(C), fxm(C), transmitfax(C), sendfax(I)
Appendix E.
NAME
tiffcat - concatenate TIFF files
SYNOPSIS
tiffcat -o output files ...
DESCRIPTION
The tiffcat program concatenates all of the named files into a single TIFF file. If any of the TIFF images contain a PageNumber tag it is updated. Images will otherwise remain untouched (and will retain their existing compression level). Note that tiffcat will neither create nor update the SubFileType of NewSubFileType tags to reflect the fact that the output file is a multi-page image. All TIFF files created by Faximum already contain the correct NewSubFileType tag.
The command tiffcompress may be used to create a multi-image TIFF file with the appropriate PageNumber and NewSubFileType tags.
SEE ALSO
tiffcompress(C), tiffsplit(C)
NAME
tiffcompress - TIFF image compressor
SYNOPSIS
tiffcompress [-c compression] -o output file1 file2 ...
DESCRIPTION
tiffcompress concatenates and reformats the TIFF images in the input files (file1, file2, etc.) creating a new output TIFF file.
-c compression
Arguments to -c can be a hex number (prefixed by 0x), an octal number (prefixed by 0), or a decimal number (no prefix). Compression may be one of the following values:
1 - no compression;
2 - CCITT Group 3 1-D Modified Huffman with no EOL codes;
3 - CCITT Group 3 1-D Modified Huffman with EOL codes and no padding;
0x43 - CCITT Group 3 1-D Modified Huffman with byte-aligned EOL codes; or
32773 - PackBits compression.
-o output Specifies the output file.
The default compression used by Faximum for TIFF files it creates is 0x43 (this is compliant with the requirements of TIFF Class F files).
Some graphics or word processing programs cannot handle all forms of compression. WordPerfect for example, cannot handle type 0x43 but can handle compression types 1 and 2. When in doubt, try compression type 1.
NAME
tiffcut - extract a rectangular part of a larger image
SYNOPSIS
tiffcut [-x n] [-y n] [-h n] [-w n] -o outputfile inputfile
DESCRIPTION
The tiffcut utility extracts an arbitrary rectangle from a TIFF file and creates a new TIFF file containing the portion of the image cut out of the original TIFF file.
OPTIONS
-x n Sets the distance from the left edge of the image where the cut rectangle starts. By default, the cut starts at the left edge of the image.
-y n Sets the distance from the top edge of the image where the cut rectangle starts. By default, the cut starts at the top edge of the image.
-h n Sets the height of the cut rectangle. By default, the cut rectangle ends with the bottom of the image.
-w n Sets the width of the cut rectangle. By default, the cut rectangle ends with the right edge of the image.
In all of the above, the distance (by default) is in inches. If desired, you can suffix the number with c for centimeters, i for inches, and p for pixels.
EXAMPLE
This example extracts a signature from a page that has been scanned in (or received by fax). This example assumes that the signature is contained within an area that is one inch top to bottom and three inches left to right, and that the upper left-hand corner of the signature area is four inches down from the top of the page and two inches in from the left edge of the page.
tiffcut -x 2i -y 4i -h 1i -w 3i -o signature page.tif
NAME
tiffdisplay - display TIFF files on a CRT graphics adapter
SYNOPSIS
tiffdisplay [ -f device ] [ -r ] TIFF-files...
DESCRIPTION
The tiffdisplay program displays the named TIFF files on the console (the default) or the named display device. The program currently supports monochrome graphics adapters, as well as CGA, EGA, and VGA cards. The program also works with the multi-display devices made by companies such as AMR, Maxpeed, and Sun River.
OPTIONS
-f device The device to use to display the TIFF files. Must be one of /dev/cga, /dev/color, /dev/colour, /dev/ega, /dev/mono, /dev/monochrome, or /dev/vga.
-r Causes tiffdisplay to display the images in reverse-video.
tiffdisplay also accepts a number of commands that may be typed in from the keyboard. To enter one of the following commands, type `:' first, followed by the name of the command.
abort Exit tiffdisplay with a return code that will indicate to the calling program that tiffdisplay was aborted. This feature is usually used when tiffdisplay is previewing a FAX to be sent and the user wishes to cancel the FAX request.
bind-to-key key command
This command can be used to associate certain keys with certain commands. Key may be any sequence of characters including:
e or E to represent escape;
r to represent carriage return character;
n to represent a newline character;
f to represent a form-feed character;
b to represent a backspace character; and
n or nn or nnn to represent an unprintable character using octal digits.
Any other character will be taken literally. Command may be any one of the commands listed here.
bind-to-function-key function-key command
This command can be used to associate certain function keys with certain commands. Key may be any of the following names for function keys: f1...f12, insert, home, pageup, pagedown, delete, end, up, down, left, and right. (The terminfo database entry for the terminal must have these function keys defined.) Command may be any one of the commands listed here.
extended-command
This command causes tiffdisplay to enter extended-command mode and accept typed commands from the user.
flip This command causes the image to be flipped upside down (helpful when reading a FAX from someone who has put the original into the FAX machine backwards).
help Display a short one-page description of the commands. Note that the key bindings described in this help are based on the defaults. If the .tiffeditrc file has been used to change the default key bindings, then the help file will not be accurate.
quit Exit the program normally.
save Save the file (including any flipped pages).
save-as filename
Save as the specified file (including any flipped pages).
next-file
Display the first image of the next file (if more than one TIFF file was specified on the command line).
previous-file
Display the first image of the previous file (if more than one TIFF file was specified on the command line).
up Shift the image down (so it appears the image window is moving up).
down Shift the image up (so it appears the image window is moving down).
left Shift the image right (so it appears the image window is moving left).
right Shift the image left (so it appears the image window is moving right).
home Shift the image to display the upper left-hand corner.
end-of-page
Shift the image to display the bottom of the page.
page-up Display the previous image (page) in the current TIFF file.
page-down
Display the next image (page) in the current TIFF file.
zoom-in Increase the magnification so that the image appears larger and the details become more visible.
zoom-out Decrease the magnification so that the image appears smaller and more of the image can be seen.
modeline mode line specification
This command controls the appearance of the line of information that appears at the bottom of the display. The following special strings will be replaced appropriately:
%f will be replaced with the name of current file;
%* prints as a `*' if the file has been modified;
%p will be replaced with the number of the currently displayed image;
%P will be replaced with the total number of images (pages) in the current file;
%x will be replaced with the current x position;
%y will be replaced with the current y position;
%z will be replaced with the current zoom factor;
%H will be replaced with the name of the key to press to obtain help;
%Q will be replaced with the name of the key to press to exit the program.
A typical mode line might be:
"File: %f%* page %p/%P file %n/%N %zX %H=HELP %Q=QUIT"
reverse-video
Display the image in reverse video.
no-reverse-video
Display the image in normal video.
In order to make tiffdisplay easier to use, there are a number of default key bindings that associate function keys with commonly used commands:
F1 - help
F2 - quit
F3 - zoom in
F4 - zoom out
F5 - flip
F7 - next-file
F8 - previous-file
Up Arrow - up
Down Arrow - down
Right Arrow - right
Left Arrow - left
PgUp Key - page-up
PgDn Key - page-down
Home Key - home
End Key - end-of-page
Ctrl C - abort
Any of these key bindings as well as the default mode line and the character to be typed to enter commands (by default `:') may be changed within the .tiffdisplayrc file. If this file is found in the user's home directory, then it will be read by tiffdisplay when the program is invoked. A system-wide start-up file may be placed in /usr/fax/lib/tiffdisplayrc. In the following example, several of the default key bindings are changed as is the default mode line and the command character.
bind-to-key f flip
bind-to-key j page-up
bind-to-key k page-down
bind-to-key l left
bind-to-key m right
bind-to-key q quit
modeline " Name: %f Page: %p/%P File: %n/%N %zX"
FILES
/usr/fax/help/tiffdisplay
the help screen
/usr/fax/lib/tiffdisplayrc
the system-wide start up file
$HOME/.tiffdisplayrc
the per-user start up file
NAME
tiffepsn - convert TIFF files to Epson format
SYNOPSIS
tiffepsn [ options ] files ...
DESCRIPTION
The tiffepsn program converts TIFF format files for printing on Epson FX-80 or compatible printers. The converted TIFF files are written on standard output. tiffepsn could, for example, be used to print a document on the default printer using the following command:
tiffepsn file | lp
OPTIONS
-60 Print at 60 x 72 dpi (60 dpi horizontal by 72 dpi vertical resolution).
-120 Print at 120 x 144 dpi. This is the default.
-240 Print at 240 x 216 dpi. Output quality will be improved at the expense of much larger print files and longer time to print a document. This option is of little benefit with low resolution fax documents.
-o list Convert only those pages specified in list of pages. Pages can be any combination of a comma-separated list of page numbers or ranges. Ranges have the form X-Y; a missing X implies page one, a missing Y implies the last page.
SEE ALSO
tiffps(C), tiffhp(C), lp(C)
NAME
tiffhp - convert TIFF files to HP PCL
SYNOPSIS
tiffhp [ options ] files ...
DESCRIPTION
The tiffhp program converts TIFF format files to Hewlett-Packard's PCL format for printing on HP compatible printers. The converted TIFF files are written on standard output. tiffhp could, for example, be used to print a document on the default printer using the following command:
tiffhp file | lp
OPTIONS
-c Generate compressed PCL output. This option is applicable only to printers that support compressed graphics. This includes the HP DeskJet printer, LaserJet III, and LaserJet IIP printer, but does not include the HP LaserJet or LaserJet IID printers.
-150 Print at 150 dpi. This is the default.
-300 Print at 300 dpi. Output quality will be improved at the expense of much larger print files.
-p paper Set paper type. The following paper types are supported: letter, legal, executive, a4, com-10, comarc, c5, dl.
-o list Convert only those pages specified in list of pages. Pages can be any combination of a comma-separated list of page numbers or ranges. Ranges have the form X-Y; a missing X implies page one, a missing Y implies the last page.
HP's PCL language, unfortunately, varies from printer to printer. Also, some printers have insufficient memory to print at 300 dpi. tiffhp's default options have been chosen to generate output printable on any HP PCL compatible printer. Improved performance can be realized, however, by taking advantage of the compressed graphics support available with the newer printers and using the -c option to tiffhp. Note that compressed output is roughly half the size of uncompressed print files.
SEE ALSO
tiffps(C), tiffepsn(C) lp(C)
NAME
tiffps - convert TIFF files to PostScript
SYNOPSIS
tiffps [ options ] files ...
DESCRIPTION
The tiffps program converts TIFF format files to PostScript format for printing on PostScript compatible printers. The converted TIFF files are written on standard output. tiffps could, for example, be used to print a document on the default printer using the following command:
tiffps file | lp
OPTIONS
-c copies Request the specified number of copies be printed.
-m length Set the longest page (in inches) that will be squeezed to fit on one page (default is 14.25). TIFF images longer than this value are split into multiple pages.
-p preamble-file
Replace the standard preamble with the file specified. Note that the preamble file must create an environment that is compatible with the standard preamble or results will be unpredictable (i.e. know what you are doing before writing your own preamble).
Although tiffps uses a very fast and compact run-length compression algorithm, the generated PostScript files are still many times the size of the original TIFF file, usually between four and eight times as large. (This is still a fraction of the size they would be if uncompressed PostScript image data were generated.) Therefore running tiffps on a large TIFF file can create an extremely large PostScript file, one that may overflow the spool area.FILES
/usr/fax/ps/standard.ps
standard preamble
SEE ALSO
tiffhp(C), tiffepsn(C), lp(C)
NAME
tiffsplit - split a multi-page TIFF file into single-page files
SYNOPSIS
tiffsplit file [name]
DESCRIPTION
tiffsplit splits a multi-page TIFF file into separate single-page files. The first page is placed in a file called nameaa, the second in nameab, and on up to namezz. If name is not specified, then x is used as the default.
SEE ALSO
tiffcat(C)
NAME
tifftiff - TIFF image reformatter
SYNOPSIS
tifftiff [-a] [-c compression] [-s length] [-h] [-l] [-O overlay] [-o output] file1 file2 ...
DESCRIPTION
tifftiff concatenates and reformats the TIFF images in the input files (file1, file2, etc.) creating a new output TIFF file. It handles images that are smaller or longer than the standard page size, and ensures that the output file is strictly TIFF-F compliant.
-a Images are to be appended to the output file (rather that overwriting it).
-c compression
Arguments to -c can be a hex number (prefixed by 0x), an octal number (prefixed by 0), or a decimal number (no prefix). Compression may be one of the following values:
1 - no compression;
2 - CCITT Group 3 1-D Modified Huffman with no EOL codes;
3 - CCITT Group 3 1-D Modified Huffman with EOL codes and no padding;
0x43 - CCITT Group 3 1-D Modified Huffman with byte-aligned EOL codes (the default); and
32773 - PackBits compression.
-h, -l Specifies the resolution of the output file. Only one may be specified. If neither is specified, use the resolution of the first TIFF file (not the overlay file).
-o Specifies the output file. No output file causes tifftiff to use a scratch file, and then copy this scratch file back to the original file.
-O overlay-file
Uses the named file (which must be a TIFF image in either standard or fine resolution) as the letterhead overlay. If the overlay file contains only one TIFF image, this image is overlayed on every page rendered by tifftiff. If the overlay file contains more than one TIFF image, the first image is overlayed on the first page rendered by tifftiff, and the second overlay file image is overlayed on every subsequent page rendered by tifftiff.
-s length Specifies the page length. If the image is longer than this, it is cut into multiple pages. If the image is shorter than this, it is centered vertically on the page. If the -s option is not specified, the page length is the longer of the image size and the overlay size (if one is specified). If the overlay is larger, the image will be centered vertically.
If the image is narrower than the page, then the image is centered horizontally.
NAME
transmitfax - high-level fax request handler
SYNOPSIS
transmitfax faxrc commandfile
DESCRIPTION
transmitfax accepts a high-level request for a fax transmission and converts it (by reference to the configuration and database files) into a low-level request that is handed off to sendfax.
The faxrc file is the user preference file (usually /usr/person/.faxrc) for the user submitting the request.
The commandfile contains parameter definitions of the form parameter = value. The value may optionally be enclosed in double quotation marks, which are required only if the value starts with a blank or contains a double quotation mark.
There are two approaches. The first permits the specification of all of the information about a single destination (i.e. a fax that is being sent to a single machine) without reference to the people or company databases. The second permits the listing of one or more destinations with reference to the people and company databases.
The single-destination approach uses the following variables:
name The name of the person to whom this fax is being sent (to be placed on the cover sheet).
title The title of the person to whom this fax is being sent (to be placed on the cover sheet).
dept The department of the person to whom this fax is being sent (to be placed on the cover sheet).
company The company to which this fax is being sent (to be placed on the cover sheet).
cc The carbon copy list for this fax (to be placed on the cover sheet).
fax1 The primary number of the fax machine to which this fax is to be sent. Note that this number ought to contain the country code, area code, exchange, and number (separated by spaces or punctuation). With most fax modems, the `,' character represents a short pause.
fax2 The number of the alternate or secondary fax machine to which this fax is to be sent. This number ought to contain the country code, area code, exchange, and number (separated by spaces or punctuation).
class The class of service to use for this transmission. This must be the name of an entry in the class of service database which the user has authorization to use.
notbefore
The earliest time this fax is to be considered for transmission. This string may contain a time (in 24-hour or am/pm notation) and/or a date (using either English words or an abbreviated format).
style The style to use for this fax transmission. The style database specifies various parameters that affect the appearance of the fax.
account The account to charge for this fax transmission (and to reference for telephone charge numbers).
The multiple-destination approach uses the following variables:
dest1person
The name of the first person (actually the short name used to index into the people database) to whom this fax is to be sent (and similarly for dest2person, ...).
dest1database
The name of the database that contains the name of the person (for the first destination).
dest1class
The class of service for the fax being sent to the first destination.
dest1account
The account to use for the fax being sent to the first destination.
Both approaches use the following variables:
from The name of the person who is sending this fax (to be placed on the cover sheet).
f_title The title of the person who is sending this fax (to be placed on the cover sheet).
f_dept The department of the person who is sending this fax (to be placed on the cover sheet).
subject The subject line that is to appear on the cover sheet of this fax.
cover The name of the file that contains the message that is to appear on the cover sheet of this fax.
preview An indication (Yes or No) of whether this fax is to be previewed (displayed on the screen) prior to transmission.
notify An indication (Yes or No) of whether the submitting user is to be notified of a successful fax transmission.
print An indication (Yes or No) of whether this fax is to be printed prior to transmission.
printer The name of the printer to be used if printing is requested.
item1name
The file name of the first attachment (and similarly for item2name, item3name, ...).
item1type
The type of the first attachment (and similarly for item2type, etc.). Supported types include ASCII, HP PCL, PostScript, and TIFF. Note that use of the PostScript file type requires that the PostScript emulator be installed.
item1style
The style of the first attachment (and similarly for item2style, etc.). This must either be the name of an entry in the style database or an empty string (in which case the style specified for the fax as a whole will be used).
Note that in Release 1 transmitfax supported two parameters called item1resolution and item1length (in place of item1style). These tags are still supported by transmitfax in order to support existing applications. New users of transmitfax are encouraged to use the item1style parameter.
FILES
~/.faxrc user
preference file
~fax/database
directory of database files
SEE ALSO
account(D), class(D), sendfax(C), Appendix E.
NAME
faxcico - send/receive daemon
DESCRIPTION
The faxcico program handles the actual transmission and reception of fax files. It is called by faxsched(D) and faxlisten(D) as necessary and is usually not invoked directly.
NOTES
Faxes that fail after being partially transmitted are restarted after the last page known to have been successfully received. At least two pages must have been received before partial retransmission will be attempted, otherwise the entire request starting at the first page will be sent on the next try.
If specified, faxcico will use the retry-coversheet entry in the control file; otherwise, /usr/fax/coversheet/retry.tif is used if it exists.
faxcico will write-lock the control file using fcntl() before attempting to transmit the request. Control files that cannot be write-locked are skipped.
SEE ALSO
sendfax(C), config(F)
NAME
faxsched - fax request scheduler
SYNOPSIS
faxsched [ -d ]
DESCRIPTION
faxsched manages out-going fax requests, calling faxcico whenever appropriate to deliver a fax request. faxsched normally examines the queues once every minute looking for new requests.
faxsched maintains a checkpoint file in /usr/spool/fax/scheddump that contains faxsched's process id and information on the last attempted delivery time of any queued requests. The process id is used by programs such as sendfax to notify faxsched that new fax requests have been submitted and that a queue run should be performed immediately.
Normally, faxsched should be invoked at boot-time from a system startup file. Only one faxsched may be active; faxsched will exit if it detects that another is already active.
OPTIONS
-d This option is used to have faxsched generate debug output.
FILES
/usr/fax/lib/faxcico
fax transmit
/usr/spool/fax/scheddump
scheduler checkpoint file
/etc/rc2.d/S99fax
Faximum daemon startup file (UNIX)
SEE ALSO
faxq(C), sendfax(C)
NAME
config - master configuration file
PATHNAME
/usr/fax/config
DESCRIPTION
The following table lists the various parameters. These parameters are all optional unless otherwise noted.
The config file contains information that controls the operation of the Faximum system.
The file consists of a number of lines of the form name = value, where name is the name of a parameter and value is the value the parameter is to have. If a parameter value contains white space, it must be quoted. The value component may be quoted using the same syntax as the shell and may include any of the following escape sequences: \b (backspace), \e (escape), \f (formfeed), \n (newline), \r (carriage return), \t (tab), and \nnn (character with octal value nnn). For example:
name = value
name = "value value value"
name = "This \" string is funny"
The following table lists the various parameters. These parameters are all optional unless otherwise noted.
completion-program = program-pathname
Program to run when a fax request is dequeued either because it was successfully transmitted, or because faxsched(C) decided to cancel the request. Program must be located under ~fax.
date-format = strftime-string
strftime(F) format string for log file time stamps. Default format is "%x %X" (i.e. mm/dd/yy hh:mm:ss).
default-priority = number
Default fax request priority used when a fax request contains no priority specification. The larger the number, the higher the priority. Default priority is 50.
default-retry-limit = number
Default number of retries when a fax request contains no retry specification. Default is no retry limit.
default-retry-delay = number
Default minutes between retries when a fax request contains no retry specification. Default is five minutes between retries.
minimum-free-blocks = number
Minimum number of blocks free in file system containing /usr/spool/fax/inbox before faxlisten(C) will answer an incoming fax call. A value of zero implies "always answer".
minimum-idle-lines = number
Minimum number of fax lines idle before a transmit attempt will be made.
spool-directory = pathname
The fax system spool directory. The compile-time default is /usr/spool.
suspend-failed-requests = yes or no
suspend-completed-requests = yes or no
The disposition of completed requests. Specifies whether a fax request will be moved to the suspended queue if it has failed/completed.
hercules-graphics-ioctl = number
hercules-portio-ioctl = number
cga-graphics-ioctl = number
cga-portio-ioctl = number
ega-graphics-ioctl = number
ega-portio-ioctl = number
vga-graphics-ioctl = number
vga-portio-ioctl = number
modeswitch = number
Display adapter parameters needed by cpcscan(C) and tiffdisplay(C) to put the display into graphics mode.
The above parameters override compile-time values suitable for systems running SCO UNIX or SCO Xenix.
Numbers with a leading `0' imply octal conversion; numbers with a leading 0x imply hexadecimal conversion. Otherwise decimal conversion is used.
All of the xxx-graphics-ioctl numbers are bit-or'ed with modeswitch.
Setting number to zero has the effect of disabling that ioctl, and forces cpcscan(C) and tiffdisplay(C) to bypass the vendor supplied display adapter driver and program the display adapter directly using in() and out() instructions.
This is the recommended procedure when installing Faximum on non-SCO systems.
EXAMPLE
debug-mode = Yes
default-area-code = 604
default-country-code = 1
default-fax = fax-line-1
default-priority = 50
default-retry-limit = 5
default-retry-delay = 5
default-scanner = /dev/scan0
fax-operator = +fax,root
intelligent-dialling = Yes
minimum-free-blocks = 1000
minimum-idle-lines = 0
spool-directory = /usr/spool/fax FILES
/usr/fax/config
system configuration file (for defaults)
SEE ALSO
device(F), sendfax(C), faxsched(C), faxlisten(C),
cpcscan (C), tiffdisplay(C), strftime(I)
NAME
device - master device configuration files
PATHNAME
/usr/fax/dev/*
DESCRIPTION
The device file describes a fax line and its associated fax modem. See the manual page for the config(F) file for information on the parameters in this file.
The following table lists the various parameters. All parameters are optional unless otherwise noted.
The first set of parameters applies to all device types.
device-type = string
This parameter is mandatory. It specifies the device type (either the fax modem manufacturer, or when the fax modem conforms to a recognised standard, the name of that standard).
Currently supported device types are cpc and eia592).
receive-only = yes or no
This parameter designates a fax line as receive-only. Default is "no".
line-type = string
This parameter is mandatory. This specifies the line type (or trunk group) to which this fax line belongs.
pulse-dial = yes or no
This parameter allows you to specify pulse or tone dialling. Default is modem specific.
tsi = string
This sets the transmit station identification. Default is a zero length string. Strings longer than 20 characters are truncated. All fax modems must support any of `+', `0' to `9', and a space. Many fax modems will also accept other alphabetic characters. Consult your modem manufacturer's manual for more information.
uucp-lock-file = string
This names the lock file used to protect a device from concurrent access from programs such as uucp and cu.
The lock file is expected to contain a single line with the process id in ascii format of the program holding the lock on the fax device. There is no default.
The following applies to CPC specific devices (device-type = cpc).
dialin-device = string
This field is mandatory. This names the device to be used for incoming calls.
dialout-device = string
This field is mandatory. It specifies the device to be used for outgoing calls.
pulse-spacing = number
This sets the pulse inter-digit time in milliseconds. Legal values are 700 to 1000. Default is 1000.
pulse-break-ratio = number
This sets the make/break ratio for pulse dialling. Legal values are 10 to 100%. Default is 61%.
comma-duration = number
This sets the duration of a short pause(i.e. the `,' character) in milliseconds. Default is 500.
semicolon-duration = number
This sets the duration of a short pause (i.e. the `,' character) in milliseconds. Default is 4000.
wait-for-dialtone = number
This sets the number of milliseconds to waiting before dialling after going "off-hook". Default is 1000.
touch-tone-duration = number
This sets the touch tone digit duration in milliseconds. Default is 200.
touch-tone-spacing = number
This sets the touch tone inter digit spacing in milliseconds. Default is 100.
filter-setting = number
This is the input filter setting. It is used to compensate for marginal phone lines. Legal values are zero to three. Increasing the value improves long distance call quality at the expense of local call quality. Default is zero.
max-bad-lines = number
This sets the maximum number of bad scan lines per page. Legal values are 20 to 999. Default is 55.
number-of-rings = number
This sets the number of rings before answering an incoming call.
The following applies to Class 2 devices (device-type = eia592).
device = string
This parameter is mandatory. It names the device to be used for in/out calls (e.g. /dev/tty01).
speed = number
This sets the speed to be used during initial modem startup. Default is 19200 baud. Permitted values are 2400, 4800, 9600, 19200, and 38400.
fax-speed = number
This sets the speed to be used after switching to fax mode. Default is 19200 baud. Speeds less than 19200 baud may cause fax modem buffer overflow on receive and are not recommended.
modem-init-string = string
This specifies the string to be sent to the modem after generic modem initialisation. Modem must respond with an "OK". There is no default.
transmit-init-string = string
This specifies the string to be sent to the modem just before line goes off-hook. Modem must respond with an "OK". There is no default.
receive-init-string = string
This specifies the string to be sent to the modem just before the ATA command is issued. Modem must respond with an "OK". There is no default.
EXAMPLE
The following is an example of a CPC control file:
comma-duration = 500
device-type = cpc
dialin-device = /dev/cfax0i
dialout-device = /dev/cfax0o
filter-setting = 0
max-bad-lines = 55
number-of-rings = 2
pulse-break-ratio = 61
pulse-dial = yes
pulse-spacing = 1000
receive-only = no
semicolon-duration = 1000
touch-tone-duration = 200
touch-tone-spacing = 100
tsi = "1 604 926 8182"
line-type = default
wait-for-dial-tone = 1000
The following is an example of the Class 2 control file:
device = /dev/tty1A
device-type = eia592
line-type = default
max-bad-lines = 55
modem-init-string = "ATE0M0S0=0Q0&D3&C1W"
number-of-rings = 2
pulse-dial = no
receive-only = no
speed = 19200
tsi = "6 666 666 6666"
SEE ALSO
faxlisten(C), faxcico(C), faxsched
NAME
strftime - date and time message format specifiers
DESCRIPTION
strftime is a C language library routine that formats date and time messages according to a format specification. This routine is used in many places within Faximum and this manual page provides details on the format specifiers.
The following table lists the format specifiers available. The first column lists the string and the second describes the item. The example illustrates the output produced at 21:18:02 on the 2nd day of February, 1991 in the North American locale.
FORMAT SPECIFIERS
%a is replaced by the locale's abbreviated weekday name (e.g. `Mon')
%A is replaced by the locale's full weekday name (e.g. `Monday')
%b is replaced by the locale's abbreviated month name (e.g. `Feb')
%B is replaced by the locale's full month name (e.g. `February')
%c is replaced by the locale's appropriate date and time representation (e.g. `Mon Feb 11 21:18:02 PST 1991')
%d is replaced by the day of the month as a decimal number (01-31) (e.g. `11')
%H is replaced by the hour (24-hour clock) as a decimal number (00-23) (e.g. `21')
%I is replaced by the hour (12-hour clock) as a decimal number (01-12) (e.g. `09')
%j is replaced by the day of the year as a decimal number (001-366) (e.g. `042')
%m is replaced by the month as a decimal number (01-12) (e.g. `02')
%M is replaced by the minute as a decimal number (00-59) (e.g. `18')
%p is replaced by the locale's equivalent of a.m. or p.m. (e.g. `p.m.')
%S is replaced by the second as a decimal number (00-59) (e.g. `02')
%U is replaced by the week number of the year (Sunday as the first day of the week) as a decimal number (00-52) (e.g. `06')
%w is replaced by the weekday as a decimal number [0(Sunday)-6] (e.g. `01')
%W is replaced by the week number of the year (Monday as the first day of the week) as a decimal number (00-52) (e.g. `06').
%x is replaced by the locale's appropriate date representation (e.g. `02/11/91')
%X is replaced by the locale's appropriate time representation (e.g. `21:18:02')
%y is replaced by the year without century as a decimal number (00-99) (e.g. `91')
%Y is replaced by the year with century as a decimal number (e.g. `1991')
%Z is replaced by the time zone name, or by no characters if no time zone exists (e.g. `PST')
%% is replaced by % (e.g. `%')