Contents of the BATCHFAX.DOC file
BatchFax v2.00 Utility Documentation October 1, 1993
Copyright 1993 Delrina (Canada) Corporation
You can send documents as faxes from DOS using DosFax PRO, the DOS
edition of WinFax PRO, Delrina's award winning send and receive fax
software for Windows. When you use BatchFax in conjunction with
DosFax PRO, you can capitalize on DosFax PRO's faxing capabilities
without actually running the DosFax program interface. Instead,
the BatchFax command-line utility lets you queue up documents for
faxing from your DOS prompt.
The following documentation is a guide to using the BatchFax utility.
It provides you with the instructions and command structures necessary
to enter options, file names, and destinations. This utility is
for your convenience and is not supported by Delrina Technical Support.
However, Delrina does welcome your comments and feedback on this utility.
Before you can run BatchFax, you must create an input file. This will be
discussed later in this document. After preparing the input file, type the
command BatchFax and the input file name at the DOS prompt. This is the
The is the name of the input file that you have created
to use with BatchFax. For example, if you had saved your file as
"TEST.doc", at the prompt you would type:
Your input file is composed of three sections: options, file names, and
destinations. Each section must be separated by a single blank line. Always
remember that each line in the options section must have a corresponding
parameter. The option and its parameter are separated by an equal sign in
the following format:
If parameters are not included, you will receive error messages telling
you which lines are invalid. Each option can be in upper or lower case.
All of the options are listed below. If you do not enter data for any of
the following options, the default values will be used. If you do specify
options, you must include valid parameters with each option.
1. Executable Path where DosFax is located
This option must direct the utility to the location of the DosFax
PRO 2.0 executables and must be followed by a trailing backslash (\).
The default is C:\DOSFAX\
If you have installed DosFax in a different directory, you must
specify this in your file.
2. Data Path where your data files are stored.
This is the location of the DosFax PRO 2.0 data files as setup
in the initial installation of DosFax PRO. The data path must
also be followed by a trailing backslash.
The default is C:\DOSFAX\DATA\
If you changed your default path or executable path during installation,
make sure you specify this new path here so that BatchFax can find
The resolution values correspond to Standard mode on most fax
machines. 0 represents low resolution and 1 corresponds to
The default is 0 (low resolution).
If you wish to change your fax to high resolution you must
specify the parameter as 1.
The CoverFlag option determines if there will be a cover page.
If you specify values for CoverLogo or CoverText, CoverFlag is
automatically activated and a cover page is attached. You only
need to enter a value for this option if you do NOT specify a
logo or text to be included, meaning that you want to attach
a blank cover page.
CoverLogo specifies the name of the .FXS file you want to use
on your cover page. If you do not specify a parameter, no cover
logo will be included. If you do wish to include a logo, you must
identify the file and the location of this file.
This must be the name of a text file containing text for the cover
page. All options and variables are supported. If you do not
specify a value, no text will be included on your cover page.
If you do want to add text to your cover page, you must specify
the file and the location of this file.
This is the date that your fax will be sent. The date must be
in "dd/mm/yy" or "dd/mm/yyyy" format. If you do not enter a value,
your fax will be sent on the current date at the specified time.
You must enter new values if you want to send your fax sometime
in the future.
This is the time that your fax will be sent. The time must be in
"hh:mm:ss" format and uses a 24 hour clock. If you do not enter a
value, your fax will be transmitted immediately. If you want to
send your fax at a specific time, you must enter that time. This
allows you to take advantage oflower phone rates or make allowances
for time zone differences.
This option controls whether or not BatchFax will submit events
using the DosFax TSRs. If you are using the TSRs you will hear
a beep after each event has been submitted. BatchFax automatically
uses the TSRs if Faxcom is present (default value of 1). If UseTSR is
set to 1 but Faxcom is not present, events will be queued into the
If you enter a value of0 and Faxcom is not present, events are also
queued into the pending log. If TSRs are present when the value is
set to 0, events are queued and sent asscheduled. If UseTSR is set
to a value of 2 and FaxCom is present, the program will treat this
option as if the value was 1. However, if FaxCom is not present when
this option is set to 2, error messages will result and your fax
will not be sent.
ShowProgress controls whether or not you will receive a count of
the number of events submitted. By default, you will not receive
this count. If you wish to keep track of the number of events
submitted, you must set this parameter to a value of 1 because the
default is a value of 0.
This is the prefix to be added to all phone numbers. Remember to
add this if necessary, because there is no default prefix.
Each file name must be on a separate line and may contain DOS wild cards
(* and ?). If multiple matches are found they will be included in your
document in the order in which they are found. If a file has the extension
".fxs", it will be attached without further processing. Files with any other
extensions will be processed through the PCL4 converter before being submitted
with your document. These include .fxr and .fxd files.
If you want to include a file with your fax, simply type the location and
name of that file on its own line.
Each destination is stored in the same format as for import into DosFax
PRO 2.0. Each line should include the recipient's name and phone number and
can also include a subject for your own reference. The subject is not included
in the fax transmission.
The following format should be followed:
"Kristi Fox","555-1221","Action Data"
"Name","Phone Number","Optional Subject"
A carriage return is required at the end of all entries.
Here is an example input file with several of the options included. Remember
that any option line can be deleted if you wish to use the default values.
"Delrina Tech Support","1 416 441 0774","Question on DosFax"
Remarks or comments can be used anywhere within your file for reference, but they
must be prefaced by a semi-colon.
;Sent fax to Delrina on October 1