efax.1

efax传真软件源代码

Motorola UDS FasTalk II,
.\" Raj Mathur ([e-mail]), 0.6a, Linux 1.1.48
MultiTech 1432MU,
.\"[e-mail]
Practical Peripherals PM14400FXMT,
.\" (DEC Alpha AXP 3000/500 running OSF/1 V1.3)
Supra V32bis,
.\" [e-mail], v0.5b, SysV R4.2
.\" tbucks![e-mail]
.\" (ROCKWELL)
.\" [e-mail] (Alec Muffett), Linux 1.1.51, 
.\"  Supra FAXModem v.32bis
Telebit Worldblazer,
.\" blurfl![e-mail]
.\" Telebit Worldblazer with ROM version LA7.02. (requires -or)
.\" (my configuration required hardware flow control)
.\" [e-mail], v 0.6, Version LA7.05C.  
TKR DM-24VF+,
.\" [e-mail]
Twincom 144/DFi,
.\" (ROCKWELL, V.32AC, V1.270 TR14-Jxxx-001)
ViVa 14.4/Fax modem,
.\" [e-mail], v0.6a, Linux
Vobis Fax-Modem (BZT-approved),
.\" [e-mail] (Peter Klein), Linux, kernel 0.99.14
.\" [e-mail] (Andre Beck), v 0.6, Ultrix 4.3, gcc V2.5.8:
.\" gcc -ansi -D_XOPEN_SOURCE -O2 efax.c -o efax -lcP
Zoom VFX14.4V,
.\" [e-mail] (me!), v0.6, Linux
ZyXEL U-1496E[+], 
.\" [e-mail], v0.3 & faxmodem ROM version 5.05M)
.\" requires -or
.\" [e-mail], v0.5a & ZyXEL 1496E Plus, ROM Version 6.11a)
.\" -or -i '+FCLASS=2;+FCR=1' -c '+FDCC=1,5,2,2,0,0,0,0'
ZyXEL Elite 2864I.
.\" [e-mail], v0.7a, using -Xn (n<4)

.SH MODEM INITIALIZATION OPTIONS

The required modem initialization commands are generated by efax.
Additional commands may be supplied as command-line arguments.
The modem must be set up to issue verbose(text) result codes.
The following command does this and is sent by efax before trying
to initialize the modem.

.TP 9
.BR Q0V1
respond to commands with verbose result codes

.PP
The following commands may be useful for special purposes:

.TP 9 
.BR X3 
don't wait for dial tone before dialing.  This may be used to
send a fax when the call has already been dialed manually.  In
this case use an empty string ("") as the first argument to the
\fB-t\fP command.  Use \fBX4\fP (usual default) to enable all
result codes.

.TP 9 
.BR M2
leave the monitor speaker turned on for the duration of the call
(use \fBM0\fP to leave it off).

.TP 9 
.BR L0
turn monitor speaker volume to minimum (use \fBL3\fP for maximum).

.TP 9 
.BR E0 
disable echoing of modem commands.  See the Resolving Problems
section below.

.TP 9 
.BR &D2
returns the modem to command mode when DTR is dropped.  The
program drops DTR at the start and end of the call if it can't
get a response to a modem command.  You can use \fB&D3\fP to
reset the modem when DTR is dropped.

.TP 9
.BR S7=120
wait up to two minutes (120 seconds) for carrier.  This may be
useful if the answering fax machine takes a long time to start
the handshaking operation (e.g. a combined fax/answering machine
with a long announcement).

.SH CAPABILITIES

The capabilities of the local hardware and software can be set
using a string of 8 digits separated by commas:

.BR  \fIvr\fP,\fIbr\fP,\fIwd\fP,\fIln\fP,\fIdf\fP,\fIec\fP,\fIbf\fP,\fIst\fP

where:

.TP 9
.I vr \fP (vertical resolution) =
0 for 98 lines per inch
.br
1 for 196 lpi

.TP 9
.I br \fP (bit rate) =
0 for 2400 bps
.br
1 for 4800
.br
2 for 7200
.br
3 for 9600
.br
4 for 12000 (V.17)
.br
5 for 14400 (V.17)

.TP 9
.I wd \fP (width) =
0 for 8.5" (21.5 cm) page width
.br
1 for 10" (25.5 cm)
.br
2 for 12" (30.3 cm)

.TP 9
.I ln  \fP (length) =
0 for 11" (A4: 29.7 cm) page length
.br
1 for 14" (B4: 36.4 cm)
.br
2 for unlimited page length

.TP 9
.I df \fP (data format) =
0 for 1-D coding
.br
1 for 2-D coding (not supported)

.TP 9
.I ec  \fP (error correction) =
0 for no error correction
.\" .br
.\" 1 for EC mode with 64 byte frames (not supported)
.\" .br
.\" 2 for EC mode with 256 byte frames (not supported)

.TP 9
.I bf \fP (binary file) =
0 for no binary file transfer

.TP 9
.I st  \fP (minimum scan time) =
0 for zero delay per line
.br
1 for 5 ms per line
.br
3 for 10 ms per line
.br
5 for 20 ms per line
.br
7 for 40 ms per line

.PP

When \fIreceiving\fP a fax the \fIvr\fP, \fIwd\fP, and \fIln\fP
fields of the capability string should be set to the maximum
values that your display software supports.  The default is 196
lpi, standard (8.5"/21.5cm) width and unlimited length.

When \fIsending\fP a fax efax will determine \fIvr\fP and
\fIln\fP from the image file and set \fIwd\fP to the default.

If the receiving fax machine does not support high resolution
(\fIvr\fP=1) mode, efax will reduce the resolution by combining
pairs of scan lines.  If the receiving fax machine does not
support the image's width then efax will truncate or pad as
required. Most fax machines can receive \fIln\fP up to 2.  Few
machines support values of \fIwd\fP other than 0.


.SH HEADERS

efax adds blank scan lines at the top of each image when it is
sent.  This allows room for the page header but increases the
length of the image (by default about 0.1" or 2.5mm of blank
space is added).

The header placed in this area typically includes the date and
time, identifies the, and shows the page number and total pages.
Headers cannot be disabled but the header string can be set to a
blank line.

The default font for generating the headers is the built-in 8x16
pixel font scaled to 12x24 pixels (about 9 point size).

Note that both efax and efix have -f options to specify the font.
efIx uses the font to generate text when doing text-to-fax
conversions (during "fax make") while efAx uses the font to
generate the header (during "fax send").

.SH SESSION LOG

A session log is written to the standard error stream.  This log
gives status and error messages from the program as selected by
the \fB-v\fP option. A time stamp showing the full time or just
minutes and seconds is printed before each message.  Times
printed along with modem responses also show milliseconds.

.SH RETURN VALUES

The program returns an error code as follows:

.TP 9
0
The fax was successfully sent or received.

.TP 9
1
The dialed number was busy or the modem device was in use.  Try
again later.

.TP 9
2
Something failed (e.g. file not found or disk full). Don't retry.
Check the session log for more details.

.TP 9
3 
Modem protocol error.  The program did not receive the expected
response from the modem.  The modem may not have been properly
initialized, the correct \fB-o\fP options were not used, or a bug
report may be in order.  Check the session log for more details.

.TP 9
4
The modem is not responding.  Operator attention is required.
Check that the modem is turned on and connected to the correct
port.

.TP 9
5
The program was terminated by a signal.

.SH EXAMPLES

.B Creating fax (G3) files

The efix program can be used to convert text files to TIFF-G3
format.  For example, the following command will convert the text
file \fBletter\fP to the files \fBletter.001\fP,
\fBletter.002\fP, etc,:

.IP
.nf
.ft CW
efix -nletter.%03d letter
.ft P
.fi
.LP

Ghostscript's \fBtiffg3\fP driver can generate fax files in
TIFF-G3 format from postscript files.  For example, the command:

.IP
.nf
\f(CW gs -q -sDEVICE=tiffg3 -dNOPAUSE \\
	-sOutputFile=letter.%03d letter.ps </dev/null\fP
.fi
.LP

will convert the Postscript file
.BR letter.ps
into high-resolution
(\fIvr\fP=1) G3 fax image files \fBletter.001, letter.002,\fP ...

The images should have margins of at least 1/2 inch (1 cm) since
the fax standard only requires that fax machines print a central
portion of the image 196.6mm (7.7 inches) wide by 281.5mm (11.1
inches) high.

The efix program can also insert bitmaps in images to create
letterhead, signatures, etc.

.B Printing fax files

You can use the efix program to print faxes on Postscript or
HP-PCL (LaserJet) printers.  For example, to print the received
fax file \fBreply.001\fP on a Postscript printer use the command:

.IP
.nf
.ft CW
efix -ops reply.001 | lpr
.ft P
.fi
.LP

.B Sending fax files

The following command will dial the number 222-2222 using tone
dialing and send a two-page fax from the TIFF-G3 files letter.001
and letter.002 using the fax modem connected to device /dev/cua1.

.IP
.nf
.ft CW
efax -d /dev/cua1 \\
     -t T222-2222 letter.001 letter.002
.ft P
.fi
.LP

.B Manual answer

You can use efax to answer the phone immediately and start fax
reception.  Use this mode if you need to answer calls manually to
see if they are fax or voice.

For example, the following command will make the fax modem on
device \fB/dev/ttyS1\fP answer the phone and attempt to receive a
fax.  The received fax will be stored in the files
\fBreply.001\fP, \fBreply.002\fP, and so on.  The modem will
identify itself as "555 1212" and receive faxes at high or low
resolution (\fIvr\fP=1), at up to 14.4 kbps (\fIbr\fP=5).

.IP
.nf
.ft CW
efax -d /dev/ttyS1 -l "555 1212" \\
   -c 1,5 -r reply
.ft P
.fi
.LP

.B Automatic answer

The \fB-w\fP option makes efax wait for characters to become
available from the modem (indicating an incoming call) before
starting fax reception.  Use the \fB-w\fP option and a
\fB-i\fPS0=\fIn\fP option to answer the phone after \fIn\fP
rings.  The example below will make the modem answer incoming
calls in fax mode on the fourth ring and save the received faxes
using files names corresponding to the reception date and time.

.IP
.nf
.ft CW
efax -d /dev/ttyb -w -iS0=4 2>&1 >> fax.log
.ft P
.fi
.LP

.B Sharing the modem with outgoing calls

The modem device can be shared by programs that use the UUCP
device locking protocol.  This includes pppd, chat, minicom,
kermit, uucico, efax, cu, and many others others.  However,
locking will only work if all programs use the same lock file.

efax will lock the modem device before opening it if one or more
UUCP lock file names are given with \fB-x\fP options.  Most
programs place their lock files in the \fR/usr/spool/uucp\fP or
\fR/var/lock\fP directories and use the name \fRLCK..\fP\fIdev\fP
where \fIdev\fP is the name of the device file in the /dev
directory that is to be locked.

If the \fB-s\fP (share) option is used, the lock file is removed
while waiting for incoming calls so other programs can use the
same device.

If efax detects another program using the modem while it is
waiting to receive a fax, efax exits with a termination code of
1.  A subsequent efax process using this device will wait until
the other program is finished before re-initializing the modem
and starting to wait for incoming calls again.

Programs that try to lock the modem device by using device
locking facilities other than UUCP lock files not be able to use
this arbitration mechanism because the device will still be open
to the efax process.  In this case you will need to kill the efax
process (e.g. "fax stop") before starting the other program.

When efax is waiting for a fax it leaves the modem ready to
receive in fax mode but removes the lock file.  When a slip or
PPP program takes over the modem port by setting up its own lock
file efax cannot send any more commands to the modem -- not even
to reset it.  Therefore the other program has to set the modem
back to data mode when it starts up.  To do this add a modem
reset command (send ATZ expect OK) to the beginning of your slip
or PPP chat script.

.B Accepting both fax and data calls

Many modems have an adaptive data/fax answer mode that can be
enabled using the \fB-j+FAE=1\fP (for Class 1) or \fB-jFAA=1\fP
(for Class 2[.0]) initialization string.  The type of call (data
or fax) can then be deduced from the modem's responses.

Some modems have limited adaptive answer features (e.g. only
working properly at certain baud rates or only in Class 2) or
none at all.  In this case use the initialization string
\fB-i+FCLASS=0\fP to answer in data mode first and the \fB-oa\fP
option to then hang up and try again in fax mode if the first
answer attempt was not successful.  This method only works if
your telephone system waits a few seconds after you hang up
before disconnecting incoming calls.

If the \fB-g\fP option is used then the option's argument will be
run as a shell command when an incoming data call is detected.
Typically this command will exec \fBgetty\fP(8).  This program
should expect to find the modem already off-hook and a lock file
present so it should not try to hang up the line or create a lock
file.  Note that the modem should be set up to report the DCE-DTE
(modem-computer, e.g. CONNECT 38400) speed, not the DCE-DCE
(modem-modem, e.g. CONNECT 14400) speed.  For many modems the
initialization option -iW0 will set this.

The following command will make efax answer incoming calls on
\fB/dev/cua1\fP on the second ring.  This device will be locked
using two different lock files but these lock files will be
removed while waiting for incoming calls (\fB-s\fP).  If a data
call is detected, the \fBgetty\fP program will be run to
initialize the terminal driver and start a \fBlogin\fP(1)
process.  Received fax files will be stored using names like
\fBDec02-12.32.33.001\fP, in the \fB/usr/spool/fax/incoming\fP
directory and the log file will be appended to
\fB/usr/spool/fax/faxlog.cua1\fP.

.IP
.nf