Configuration
Parameters
Configuration parameters
for Fax2Send are held in the file /etc/fax2send/config. The file has
the same format as a Windows ".INI" file.
Sections
[General]
- Front_Sheet
is the file to be used as the default server based
Cover Sheet.
- PrintMonitors
is a list of Fax2Send Print Monitors which are
used to capture the output from printers on a Unix or Linux server.
- Debug
determines whether trace output is written to /var/spool/fax2send/log/fax2send.
Values of yes or no (default no)
- Lang
is a 2 letter code that sets the language to be used by Fax2Send.
Currently only English (en) and German(de) are supported.
- Front_Sheet_Lines
is the number of lines available for messages on the front/cover sheet.
- InTrays
determines whether received messages are split up into separate folders
depending on information in the routing tables. Values of yes
or no.
- FaxLink
is the same of the script to run every time a new fax message is received.
Normally set to faxlink.
- Devices
lists the interface to be started with Fax2Send. After installation
this is usually set to "preview email faxmodem".
- Retry_Freq
is the number of minutes between request retries
- Retries
is the number of retries for non-busy numbers.
- Eng_Retries
is the number of retries for busy numbers.
- Stay_Time
is the number of minutes requests stay in current queue
- Audit_Stay_Time
is the number of days requests stay in old queue.
- Received_Image_Cache
is the maximum disk space allowed for received faxes in K.
- Routing
determines the precedence given to the different pieces of routing
information. CLI/CSI means route on CLI first.
- Qcheck
is the frequency in minutes that the queue is checked.
- Oti controls
whether a black information line is printed at the top of every page.
Values of yes or no.
- Oti_Text
is a string that controls the format of the black line at the top
of every page. The parameters each start with a $ and have the following
meanings:
- Site_ID.
- Destination
fax number.
- Senders name.
- Current page.
- Total number
of pages.
- Date and
time.
- Max_Batch
is the maximum number of requests to put in a single transmissions.
- Mshot_Stay_Time
is the time in minutes for mailshot requests to stay in the current
queue.
- Network_Headers
determines whether Fax2Send will attempt to transfer cover sheets
from remote systems. This is normally set to no.
- Time_Format
formats date display in the OTI line default is: %a %b %d %H:%M %Y
| |
%% |
|
same
as % |
| |
%a |
|
locale's
abbreviated weekday name |
| |
%A |
|
locale's full
weekday name |
| |
%b |
|
locale's
abbreviated month name |
| |
%B |
|
locale's
full month name |
| |
%c |
|
locale's
appropriate date and time representation |
| |
%C |
|
locale's
date and time representation as produced by 'date' |
| |
%d |
|
day
on month (0 to 31) |
| |
%D |
|
date
as %m/%d/%y |
| |
%e |
|
day
on month (1 to 31; single digits preceded by a blank) |
| |
%h |
|
Locale's
abbreviated month name |
| |
%H |
|
Hour
(00 - 23) |
| |
%I |
|
hour
(01 - 12) |
| |
%j |
|
day
number of year (001 - 366) |
| |
%m |
|
month
number of year (01 - 12) |
| |
%M |
|
minute
(00 - 59) |
- Save_Sent_Images
determines whether the images of sent faxes are saved in the sent
image cache.
- Sent_Image_Cache
specifies the size in K of the sent image cache.
- Stderr
is the file in /var/spool/fax2send/log to write trace information
to.
- Site_Id
is usually set to the name of the company or individual running the
software and is used on cover sheets and OTI lines.
- Socket
is the socket number to use for network connections.
[PCL]
The PCL Section
is used to hold the parameters that control the HP
LaserJet III Emulation used by Fax2Send.
- Symbol_Set
sets the default symbol set used by the
Fax2Send PCL emulation.
- Paper
should be set to either a4 or letter to set the default
paper size.
[EPS]
The EPS section
is used to hold the parameters for the Postscript Emulation which is
normally implemented externally to Fax2Send using Ghostscript. The emulation
relies on the command /usr/bin/gs.
- Paper
should be set to either a4 or letter to set the default
paper size.
[Paper]
The Paper section
defines the length in pixels and lines of A4 and Letter sized paper.
- a4 is
the default length in lines for A4 paper and is normally set to 66.
- a4_len_100
is the length in dots for A4 paper at 100 dpi.
- a4_len_200
is the length in dots for A4 paper at 200 dpi.
- letter
is the default length in lines for Letter paper and is normally set
to 60.
- letter_len_100
is the length in dots for Letter paper at 100 dpi.
- letter_len_200
is the length in dots for Letter paper at 200 dpi.
[Preview]
The Preview section
defines the parameters for the preview interface that is responsible
for the dummy transmission of requests sent to the preview fax number.
This section should not be edited for normal function of Fax2Send.
[Email]
The email section
defines the parameters for the email interface that provides the fax
to email gateway in Fax2Send. Only the following parameters may be changed:
- Device
is the host name or IP address of an SMTP server.
- Port
is the port number used by the SMTP server and is normally set to
25.
[InTray Section]
The InTray Section
defines the InTrays that can be viewed by different users. Each entry
in this section takes the form user name=list of intrays.
default
defines the list of InTrays for users who have individual entry in the
section (V2.1-5 and later only).
[Faxmodem]
The Faxmodem section
defines the parameters for the fax modem.
- Type
specifies the type of modem and must be set to F.
- Make
specifies the type of fax modem and is normally set to Class2
- Interface
specifies the name of the executable to be run as the modem interface
and is normally set to class2.
- Stty
defines the line characteristics for a serial device used by the interface.
A typical value is 19200|cs8|cread|ignpar|echok|clocal|hupcl.
- LockFile
can be used to allow sharing of a modem by the interface and another
application such as mgetty. A typical value might be /var/lock/LCK..ttyS0.
- Speed
sets the speed at which the fax transmission will take place. Allowable
values are 14400 9600 7200 4800
- Init_String
is a string to be sent to the modem at the start of the initialisation
process. A typical value might be AT&D3.
- Reset_String
is a string to sent to the modem after any transmission or reception.
- Device
specifies the serial device file or TCP/IP terminal server to which
the modem is connected.
- Port
is an optional parameter which should only be set if the modem is
connected to a TCP/IP terminal server. In that case it should be the
socket number used for that serial port on the terminal server.
- Receive
determines whether the interface will monitor for incoming faxes.
Note that this is not compatible with using a lock file. Values of
yes or no.
- Rings
sets the number of times the modem will allow the phone to ring before
picking up the call. This can be useful for sharing the line with
another device.
- Send
determines whether the modem can send faxes. Values of yes
or no.
- Predial
specifies the string to be added to any fax number. This string can
include any characters normally used in an AT dial string.
- T
uses Tone dialing.
- P
uses Pulse dialing.
- ,
inserts a pause.
- W
waits for a new dial tone.
- Debug
is the name of the debug trace file in /var/spool/fax2send/log.
- Accept_Low_Quality_Page
determines whether Fax2Send aborts a transmission if line errors meant
that a page was received at the remote end but with some errors. Values
of yes or no.
- Allow_Cancel
controls whether a user can stop a fax during transmission. Values
of yes or no.
- Error_Correction
specifies the error correction level to be used. Values of 0
and 1. Doesn't work with most modems.
- Flow_Control
can be set to Hardware or Software. Note that some modems
also need a flow control command including in the Init_String.
For example a Multitech modem in Software flow control may also need
the string "&E5" including in the Init_String.
- Invert_Received_Images
controls the order in which the interface looks at the byte order
of the image before cleaning. If the interface cannot make sense of
the image then it will byte invert and try again - so this parameter
can only ever have a fine tuning effect on the interface.
- Local_Id
is the identification string sent to the remote fax machine when a
fax is sent or received.
- Raw_Connection
only applies to terminal servers and should normally be set to no.
Values of yes or no.
- Slow_Receive
when set to yes will slow down the reception of faxes to allow
for serial devices with poor inbound flow control.
- Speaker_Setting
is the speaker setting for the modem. 0 = off, 1 = on
for dial/answer, 2 = always on, 3 = on for connect.
- Use_Software_TimeOut
controls whether the interface uses software time outs or uses the
device drivers capabilities. Values of yes or no, normally
set to no.
- Wait_For_Carrier
determines whether the interface opens the port in blocking mode.
Values of yes or no, normally set to no.
- Scan_Time
specifies the scan time index used when negotiating transmission.
0 = (0/0) 0ms Coarse and 0ms Fine, 1 = 5/5, 2=10/5, 3=10/10, 4=20/10,
5=20/20 6 = 40/20 and 7=40/40. Can be useful to vary if there are
problems using a particular modem.
- Group
is an optional parameter that specifies the name of the group for
this modem
[OutBoundRouting]
The OutBoundRouting
section can be used on multi-line systems to route faxes through particular
modems based on the number being dialled. Each line in the section has
the format pattern=list of modems or groups. e.g. 0045*=faxmodem
[Mail2fax]
The Mail2fax section
contains the parameters for the email to fax gateway.
- to_name_change_ok
has value yes or no. When set to yes the full
name of the addressee will be used on the cover sheet (if possible).
- to_text
specifies the locating text for the addressee.
- from_name_change_ok
has value yes or no. When set to yes the full
name of the sender will be used on the cover sheet (if possible).
- from_text
specifies the locating text for the sender.
- include_fax_header
has value yes or no. When set to yes a cover
sheet will be sent with the email content.
- fax_header_template
specifies the name of the cover sheet
to use.
- shaded_fax_header
has value yes or no. When set to yes a shaded
border is used on the cover sheet.
- lines_on_header_sheet
specifies the number of lines available for the email message on the
cover sheet.
- include_email_header
has value yes or no. When set to yes the header
from the email will be included in the fax.
- send_fax_in_fine_mode
has value yes or no. When set to yes the fax
will be sent in fine mode.
- subject_text
specifies the locating text for the subject.
- max_subject_length
specifies the maximum length for the subject field.
- header_in_bold
has value yes or no. When set to yes the header
part of the email is sent in bold text.
- message_in_bold
has value yes or no. When set to yesthe message
part of the email is sent in bold text.
- header_title
specifies a title for the email header.
- message_title
specifies a title for the message body.
- header_font
is a PCL Escape Sequence that defines
the font to use in the header.
- message_font
is a PCL Escape Sequence that defines
the font to use in the message body.
- mail_level
controls whether Fax2Send sends mail to report on the progress of
the fax and should be a value acceptable to the -m flag with the fax2
command.
[Printer-Fax2Send]
The Printer sections
define a print monitor that captures output from a Unix or Linux printer.
- Fifo
is the name of the named pipe to monitor for input.
- TempFile
is the base path for the temporary file created when input is read
from the pipe.
- Command
is the command to be executed when a print file is captured. The arguments
are in order; printer, user, host, print file.
[InboundFax2Mail]
- TIF
- "yes" or "no" to allow tiff attachment to be
sent forwarded by email
- InLine
- "yes" or "no" to show inline jpeg image of fax
forwarded by email
- JPEGWidth
- "600" defines width of jpeg image to attach
Address Section
The Address section
is used to specify the address of the company using Fax2Send. Each line
has the format linen=address line n
