XFAX 4.3a - User's Guide

Table of ContentsPreviousNextIndex

15. Keyword reference

The keywords below are used in the configuration file ETCDIR/config. The file can be modified according to requirements with the help of a normal text editor. If changes are made in the file the faxmaster must be stopped and started again for the changes to take effect.

When using several lines the keyword can be specific for a certain line (local keyword) given by means of the following syntax:

LINE tty <
keyword
etc.
>

For example:

LINE tty1a <
INIT_STRING = "AT&H3"
DIAL_PREFIX = "0W"
SEND_ONLY  
>

This means that several different types of modem can be used and that certain lines can be used only for sending and others only for receiving etc.

Note that keywords which apply generally for all lines, global keywords, must be placed in front of the keywords which are specific to the line in order to achieve the intended effect. If the same keywords occur several times, the last definition given always applies.

15.1 General keywords

15.1.1 FAXLINE

FAXLINE = tty1 or
FAXLINES = tty1[:tty2...]

Gives the port or ports the fax system should use. /dev should not be given before the name of the port. Note that the number of ports which the system takes note of is limited by the scope of the licence agreement.

15.1.2 ACCESS_HTTP

ACCESS_HTTP="string"

Specifies which hosts or network can access the HTTP server.

Example:

ACCESS_HTTP=10.1.11.10/32,10.5.1.0/24

See also: USER_FILE

15.1.3 ACCESS_SMTP

ACCESS_SMTP="string"

Specifies which hosts or network can access the SMTP server.

Example:

ACCESS_SMTP=10.1.11.10/32,10.5.1.0/24

See also: USER_FILE

15.1.4 ACCEPT_USERS

ACCEPT_USERS="user1[:user2 ...]"

Specifies that only the given users are allowed to use a fax device. Useful when having multiple devices where a specific device should be dedicated to specific users.
See also: DENY_USERS

15.1.5 ADMINISTRATOR

ADMINISTRATOR="string"

Indicates which user is to be the system administrator. As system administrator you can see and manipulate all the user queues, while as a normal user you can only see your own queues. Several administrators can be appointed by giving the user name separated by a colon, ":", e.g. ADMINISTRATOR = "root:kalle".

15.1.6 ALERT_USER

ALERT_USER = "recipient1 [recipient2 ...]"

If for any reason faxmaster dies, a message is sent to the recipient indicated. Addresses of recipients can, of course, be both external and internal. Several users can be shown separated by a space.

15.1.7 ARCHIVE_SENT

ARCHIVE_SENT

Indicates that faxes that have been sent should be filed under SPOOLDIR/ARCHIVE.

15.1.8 AUTOPRINT

AUTOPRINT="string"

Indicates that a received fax should always be sent to a printer. The string is a command that should take care of the printout data and forwards it to an HP Laserjet compatible printer. E.g.: AUTOPRINT=" 1p -dLASER". The command is executed automatically when the system has received a fax.

15.1.9 BROKEN_SELECT

BROKEN_SELECT

This indicates that XFAX should be run on SCO Xenix.

15.1.10 BUSY_FAIL

BUSY_FAIL=number of retries

Gives the maximum number of retries when engaged. Normally engaged is not counted as a failed attempt, but with the help of this keyword it is possible to get round this.

15.1.11 CHARACTER_SET

CHARACTER_SET=characterset

Gives the set of characters that should be used. See the command faxsend for possible options.

Standard value: 5 (Swedish 7 bit mapping)

15.1.12 CLASS

CLASS=string

By default faxmaster tries to determine if it is a Class 2 or Class 2.0 device. By using CLASS=2 or CLASS=2.0 you can avoid that. It makes the initialisation a little bit quicker.

15.1.13 CODE_END

CODE_END=string

Gives the character sequence to mark the end of a document code.

Standard value: "]]"

15.1.14 CODE_START

CODE_START=string

Gives the character sequence to mark the start of a document code.
Standard value: "[["

15.1.15 COMPANY

COMPANY=string

This gives the company name which will appear on the cover sheet when sending by means of the script xfax.

15.1.16 DEBUG

DEBUG

If this keyword is given, debug information is written to standard output, i.e. on the screen when faxmaster is started. Can be used to search for faults.

15.1.17 DEFAULT_FONT

DEFAULT_FONT=filename

Indicates the typescript that should be chosen when converting text in normal cases, when the typeface is not chosen by means of control codes. The file name is a file under the directory ETCDIR/Fonts. E.g. DEFAULT_FONT = counu100.fp2 to choose Courier 10 cpi normal style.

15.1.18 DEFAULT_MARGIN

DEFAULT_MARGIN=n

When sending a plain text file this keyword can be used to add a left margin. For example to get a left margin of 10 spaces, define DEFAULT_MARGIN=10.
Standard value: 0.

15.1.19 DENY_USERS

DENY_USERS="user1[:user2 ...]"

Specifies that the given users are not allowed to use a fax device. Useful when having multiple devices where a specific device should not be available to specific users.

See also: ACCEPT_USERS

15.1.20 DIAL_PREFIX

DIAL_PREFIX="string"

Gives the prefix that is added before the telephone number when calling. E.g. DIAL_PREFIX = "0W" can be used to get the modem to come out through an exchange by dialling a zero and then waiting for a tone before the rest of the number is dialled.

15.1.21 DEFAULT_PRINTER

DEFAULT_PRINTER=printer name

Gives the standard printer to use when printing out a fax if no other printer has been explicitly given.

15.1.22 DIAL_TIMEOUT

DIAL_TIMEOUT=seconds

Indicates how long after an attempt is made to make a connection the attempt should be discontinued if the connection is not established.

15.1.23 DOMAIN

DOMAIN=domain

Specifies the domain name to use when sending e-mail.

15.1.24 EXEC_WORKDIR

EXEC_WORKDIR=directory

Indicates which directory should be used as a working directory when a program given by EXECUTE_AFTER_REC and EXECUTE_AFTER_SEND is executed.

15.1.25 EXECUTE_AFTER_RECEIVE

EXECUTE_AFTER_RECEIVE=program

Gives a program which is executed after receiving a fax.

The program is executed with the following arguments in the sequence given:

ID ID of fax
Result code Result code from the reception.

15.1.26 EXECUTE_AFTER_SEND

EXECUTE_AFTER_SEND=program

Gives a program which is executed when a fax is concluded, i.e. has been sent or not been able to be sent.
The program is executed with the following arguments in the sequence given:

ID The ID of the fax
Fax number The recipient's fax number
Result code Can be any of the following values: 0 (OK), 1 (Connect), 2 (Ring), 3 (No carrier), 4 (Error), 6 (No dial-tone), 7 (Busy), 8 (No answer), 19 (No line), 20 (Interrupted) or any of the result codes the modem uses in fax mode (see the description of faxq in the chapter: "Handling faxes", for a more detailed description).
No of retries The number of attempts to send the fax.
Notes Any notes which are attached to the fax. This is added with the parameter -n to faxsend.
Conn. time The number of seconds connected during the transmission attempt. This is not exact, but a good estimate.
Concl. time The time when the fax is concluded, i.e. sent or an attempt has been made for the last time.
User The user who placed the fax in the queue.

15.1.27 EXECUTE_BEFORE_SEND

EXECUTE_BEFORE_SEND=program

Gives a program which is executed before a fax is placed in queue.

The program is executed with the following arguments in the sequence given:

ID The ID of the fax
Fax number The recipient's fax number
Result code Not used.
No of retries Not used.
Notes Any notes which are tied to the fax. This is addedwith the parameter -n to faxsend.
Conn. time Not used.
Concl. time Not used.
User The user who placed the fax in the queue.

15.1.28 EXIT_STRING

EXIT_STRING="string"

Gives a command string which is sent to the modem after the call is finished. Note that ATZ (reset) is always sent to the modem before the given string is sent.

15.1.29 FAIL_DIR

FAIL_DIR=directory

The directory in which to place unsuccessful faxes. If NO_ERROR_SAVE is not defined an unsuccessful fax will end up under $HOME/Fax, but with this keyword this directory can be freely selected.

15.1.30 FAIL_FAXNO

FAIL_FAXNO=fax number

The fax number to send faxes which have not reached their destination. Can be used to get faxes which it is not possible to send to be sent to your own fax.

15.1.31 FAXHOST

FAXHOST=string

Used when XFAX is run in a network and indicates which machine should be used as a server.

The name can be a machine name or an IP address.

15.1.32 FAXNO

FAXNO=string

Gives the fax number that appears on the cover sheet, when sending by means of the script xfax.

15.1.33 FLOW

FLOW=value

Normally XFAX tries to set up the port for CTS/RTS flow control. If you give 0 as a value to the keyword FLOW, this is not done.

15.1.34 FONTDIR

FONTDIR=directory

Indicates in which directory the typeface descriptions are located.

Standard value: /etc/xfax/Fonts

15.1.35 GROUP

GROUP=value

Defines a user group. Users that belong to the same group can see and handle each other's queues. Repeating the use of this keyword can create several groups. Example:

GROUP = "kalle:nisse:pelle"

creates a group with three users.

15.1.36 HTTP_ENABLE

HTTP_ENABLE

Enable the integrated HTTP server in faxmaster.
See also: HTTP_PORT, ACCESS_HTTP, USER_FILE

15.1.37 HTTP_PORT

HTTP_PORT=number

Specifies which port the HTTP server should listen on.

Default: 7181

15.1.38 ID

ID="string"

Gives your local fax identity. This identity is exchanged between fax units during connection. The identity is then shown on activity reports and similar. Normally you use your fax number or company name as an identity. Note that certain faxes cut the identity string after 10-11 characters, and so you should choose a short and clear string.

15.1.39 INIT_STRING

INIT_STRING = "string"

Gives the initiation string that should be sent to the modem before connection is made. Parameters, which are specific to the modem, can be given for this, e.g. for flow control. E.g.: INIT_STRING = "AT&K4M1L2" for an Intertex modem which is to run XON/XOFF.

15.1.40 INT_PREFIX

INT_PREFIX = string

Gives the telephone number prefix for international calls. 00 in Sweden. Used for example by faxstat.

15.1.41 JETFAX_BUSY_TRIES

JETFAX_BUSY_TRIES = value

Gives the number of retries when the line is engaged. Used only when XFAX is used together with JetFax II.

15.1.42 JETFAX_COPY

JETFAX_COPY

Indicates that a copy of the fax is to be printed out.

Used only when XFAX is used together with JetFax II.

15.1.43 JETFAX_PAGE_TIME

JETFAX_PAGE_TIME = value

Gives the average value for a transmission time of a fax page. Used as an estimate when calculating costs.
Used only when XFAX is used together with JetFax II:

15.1.44 JETFAX_RECEIPT

JETFAX_RECEIPT = value

Indicates that a receipt should be printed out. Possible values: 0 - never, 1 - always, 2 - when there is a fault.
Used only when XFAX is used together with JetFax II.

15.1.45 LANGUAGE

LANG = language code or
LANGUAGE = language code

Indicates the language which should be used in menus etc. Permitted values are eng, swe and swe8.

Standard value: eng

15.1.46 LD_PREFIX

LD_PREFIX = string

Gives the telephone number prefix for long-distance calls. 0 in Sweden. Used for example by faxstat.

15.1.47 LINE_FAIL

LINE_FAIL = number of retries

Gives the number of attempts when the modem cannot be initiated. Normally this is not counted as a faulty attempt, but with the help of this keyword you can get round this.

15.1.48 LOCAL_PREFIX

LOCAL_PREFIX=string

Gives the telephone number prefix for your own dialing code area. If this is given it is automatically removed if it should be found when sending a fax.
08 in Stockholm.

15.1.49 LOCK_DIR

LOCK_DIR=directory

Indicates which directory should be used for locked files. This is dependent on the system.

15.1.50 LOCKING_STYLE

LOCKING_STYLE=value

Indicates which type of locked files should be created when locking fax lines. This is dependent on the operating system.

Values:

1 Linux
2) SCO
3 System V.4
4 HP-UX

15.1.51 LP

LP=string

Indicates which command should be used when printing out a fax.

Standard value: "lp"

15.1.52 LP_PRINT_OPTION

LP_PRINT_OPTION=string

Indicates which parameters are used together with the printout program, normally 1p, to indicate a special printer, e.g. "1p -d laser".
Standard value: "-d"

15.1.53 MAIL_ON_ERROR

MAIL_ON_ERROR

Indicates that the mail should be sent to the user who has placed a fax in the queue if it has not been possible to send it.

15.1.54 MAIL_ON_SUCCESS

MAIL_ON_SUCCESS

Indicates that mail should be sent to the user who has placed a fax in the queue if the fax has been sent with the status OK.

15.1.55 MAX_BPS

MAX_BPS=speed

Indicates the maximum speed of the fax modem when sending a fax in the unit bits per second (bps). Permitted values: 14400, 9600, 7200, 4800 and 2400.
Standard value: 14400

15.1.56 MAX_TRIES

MAX_TRIES=number of retries

Gives the maximum number of times a fax should be tried to be sent before the system gives up and places it in the queue for faxes not sent.

15.1.57 NICE_CONV

NICE_CONV=priority

Indicates that a lower priority than normal should be used when converting a fax.

The value can be between 0 and 20. 20 gives the lowest priority.

15.1.58 NICE_SEND

NICE_SEND=priority

Indicates that higher priority than normal should be used for sending a fax.

The value can be between 0 and 20. 20 gives the highest priority.

15.1.59 NO_ERROR_SAVE

NO_ERROR_SAVE

Indicates that the fax yfile should not be saved if it has not been possible to send a fax in a queue. This keyword is normally defined in the configuration file.

15.1.60 NO_STATISTICS

NO_STATISTICS

Indicates that statistics should not be saved in the file ETCDIR/stats.

15.1.61 OLD_SCO

OLD_SCO

If you use a SCO version before OpenServer5 and the port name has a name in the format ttyx00, where x is a capital letter, this keyword must be used so that the handling of locked files is done in the right way. This is due to a bug in older SCO versions.

15.1.62 PARTIAL_PAGES

PARTIAL_PAGES

Indicates that the last page of a fax should be cut off after the last line of data and not filled out to a full A4. This saves time when transmitting and space on the hard disk.

15.1.63 PORT

PORT=value

Indicates which port should be used when XFAX is run in a network.

Standard value: 6001

15.1.64 PRINT_REC_TO_LEFT

PRINT_REC_TO_LEFT=column

With this keyword you can adjust where the print-out of incoming faxes will be positioned on the paper. The value indicates the number of columns the data should be moved to the left.

15.1.65 PULSE

PULSE

Indicates that pulse choice should be used when making a call.

15.1.66 QUIET

QUIET

Indicates that client programs should be quiet and not write information onto the screen as standard. For example this is equal to calling faxsend with the argument -q.

15.1.67 RECEIVE_ONLY

RECEIVE_ONLY
Indicates that fax lines should be used only for receiving. This function is also controlled by the scope of your license agreement. If the fax modem is used for incoming modem traffic and outgoing fax traffic SEND_ONLY must be given, otherwise the fax server will try to answer and receive incoming calls as a fax.

15.1.68 RESOLUTION

RESOLUTION=HIGH | LOW

Gives the standard resolution of the faxes that are sent out. Note that if the fax called does not support high resolution then low resolution is negotiated. Possible values are HIGH or FINE for high resolution and LOW or STANDARD for low resolution.
A high-resolution fax is precisely twice as large as a low-resolution fax and takes twice as long to send (approx. 1 minute for an A4 page).Standard value: HIGH (high resolution)

15.1.69 RETRY_TIME

RETRY_TIME=minutes

Indicates at what minute intervals attempts should be made to send a fax that is not successfully sent.

15.1.70 REVERSE_STATS

REVERSE_STATS

Indicates that statistics lists (sent and failed faxes) should be shown in reverse order, i.e. with the most recent fax first.

15.1.71 ROUND_ROBIN

ROUND_ROBIN

When using multiple fax devices with XFAX the standard behavior is to always use the first available line for transmission so if FAXLINES=tty00:tty01, tty00 is always picked if available. By using this keyword fax lines are always used in sequential order. That is, first tty00 is used then tty01, tty00 and so on. This is really the best way to minimize non-successful attempts if a fax device should break down.

15.1.72 SEND_BPS

SEND_BPS

Normally the communication speed between the computer and the modem is 19.200 bps. By using this keyword that can be changed. Not any value can be used. Possible values: 2400, 4800, 9600, 19200, 38400. Standard value: 19200

15.1.73 SEND_ONLY

SEND_ONLY
Indicates that fax lines should be used only for sending or only for receiving. This function is also controlled by the scope of your license agreement. If the fax modem is used for incoming modem traffic and outgoing fax traffic SEND_ONLY must be given, otherwise the fax server will try to answer and receive incoming calls as a fax.

15.1.74 SMTP_ENABLE

SMTP_ENABLE

Specifies that the XFAX SMTP server should be enabled.

See also: SMTP_PORT, USER_FILE, ACCESS_SMTP

15.1.75 SMTP_PORT

SMTP_PORT=port

Specifies which port to be used by the SMTP server.

Standard value: 7180

15.1.76 SMTP_SENDER

SMTP_SENDER="string"

Specifies a sender for e-mails that XFAX generate.

15.1.77 SMTP_SERVER

SMTP_SERVER=hostname

Indicates which SMTP server to use for sending e-mail.

15.1.78 SPOOLDIR

SPOOLDIR=directory

Indicates which directory should be used to store data and control files.Standard value: /usr/spool/fax

15.1.79 STTY

STTY=string

Gives a stty string that should be sent to the port after it has been opened. Can be used to set special parameters. However it need not normally be used.

15.1.80 SYMBOL_SET

SYMBOL_SET=symbolset

Gives the set of symbols that should be used. Applicable choices are 0 for Roman-8, 1 for Latin-1 (ISO 8859-1) and 2 for Windows.
Standard value: 1 (Latin-1)

15.1.81 T30_ECM

T30_ECM=value

Set the T.30 parameter ECM (Error-Correction Mode) to the specified value.

15.1.82 T30_RTC

T30_RTC=value

Set the T.30 parameter RTC to the specified value.

15.1.83 T30_PAGELENGTH

T30_PAGELENGTH=value

Set the T.30 parameter page-length to the specified value.

15.1.84 TONE

TONE

Gives the tone that should be used when calling.

15.1.85 USE_SHM

USE_SHM

Specify that the server should use Share Memory for inter-process communication. Not all platforms support Shared Memory.

15.1.86 USER_FILE

USER_FILE=filename

Specifies a file to use for valid users of the HTTP or SMTP server.

Format of the file: username<TAB>password<TAB>type of server

Example:

user1      secret  HTTP
user2      moresecret  HTTP,SMTP
user@domain.com      sec123  HTTP,SMTP

15.1.87 WAIT_FOR_TONE

WAIT_FOR_TONE or
WAIT_FOR_DIALTONE

Indicates that the modem should wait for the connection tone before it begins to dial the telephone number. This is normally required if the telephone line is not connected to an AXE station where the connection tone is obtained immediately. This gives the same result as a "W" placed first in the telephone number.

15.1.88 XON_XOFF

Indicates that the software flow control, XON/XOFF, should be used when sending a fax. Note that INIT_STRING must be set in conformity with this.

Table of ContentsPreviousNextIndex