.TH EFAX 1 "February 1999" ""  "".UC 1.SH NAMEefax \- send/receive faxes with Class 1, 2 or 2.0 fax modem.ce 1(Please read the \fBfax\fP man page first.).SH SYNOPSIS.B efax[\fIoptions\fP][\fB-t\fP \fInum\fP [ \fIfile\fP... ]].SH OPTIONSWhere \fIoptions\fP are:.TP 9.B -a \fIcmd\fPuse the command \fBATcmd\fP when answering the phone.  Thedefault is "A"..TP 9.B -c \fIcaps\fPset the local modem capabilities.  See the section oncapabilities below for the format and meaning of \fIcaps\fP.  ForClass 1 the default is 1,n,0,2,0,0,0,0 where n is the highestspeed supported by the modem.  For Class 2 the default isdetermined by the modem..TP 9 .B -d \fIdev\fP use the fax modem connected to device \fIdev\fP.  The default is\fB/dev/modem\fP.  .TP 9.B -f \fIfnt\fPuse font file \fIfnt\fP for generating the header.  The defaultis a built-in 8x16 font.  See the efix(1) -f option for the fontfile format..TP 9.B -g \fIcmd\fPif a \fBCONNECT\fP (or \fBDATA\fP) response indicates a datacall, the shell \fB/bin/sh\fP is exec(2)'ed with \fIcmd\fP as itscommand.  \fIcmd\fP is a printf(3) format that may contain up to6 %d escapes which are replaced by the baud rate following themost recent \fBCONNECT\fP message. \fIcmd\fP typically exec'sgetty(8)..TP 9.B -h \fIhdr\fPput string `hdr' at the top of each page.  The first %d in `hdr'is replaced by the page number and the second, if any, isreplaced by the number of pages being sent..TP 9.B -i \fIstr\fP.TP 9.B -j \fIstr\fP.TP 9.B -k \fIstr\fPsend the command \fBAT\fP\fIstr\fP to the modem to initialize it.-i commands are sent before the modem is put into fax mode, -jcommands after the modem is in fax mode, and -k commands justbefore efax exits.  The only default is a hang-up (ATH) commandthat is sent before exiting only if no other -k options aregiven.  Multiple options may be used..TP 9.B -l \fIid\fPset the local identification string to \fIid\fP.  \fIid\fP shouldbe the local telephone number in international format (forexample "+1 800 555 1212").  This is passed to the remote faxmachine.  Some fax machines may not accept characters other thannumbers, space, and '+'.  .TP 9 .B -o \fIopt\fP use option \fIopt\fP to accommodate a non-standard fax modemprotocol.  See the MODEM REQUIREMENTS section below for moredetails.  The \fIopt\fPions are:.TP 9.B     0Force use of Class 2.0 fax modem commands.  The modem mustsupport Class 2.0..TP 9.B     2Force use of Class 2 fax modem commands.  The modem must supportClass 2..TP 9.B     1 Force use of Class 1 fax modem commands. The modem must supportClass 1.  By default efax queries the modem and uses the first ofthe three above classes which is supported by the modem..TP 9.B     ause software adaptive answer method.  If the first attempt toanswer the call does not result in a data connection within 8seconds the phone is hung up temporarily and answered again infax mode (see "Accepting both fax and data calls" below)..TP 9.B     e ignore errors in modem initialization commands..TP 9.B     fuse "virtual flow control".  efax tries to estimate the number ofbytes in the modem's transmit buffer and pauses as necessary toavoid filling it.  The modem's buffer is assumed to hold at least96 bytes.  This feature does not work properly with Class 2modems that add redundant padding to scan lines.  Use this optiononly if you have problems configuring flow control..TP 9.B     h use hardware (RTS/CTS) in addition to software (XON/XOFF) flowcontrol.  Many modems will stop responding if this option isused.  See the section `Resolving Problems' before using thisoption..TP 9.B     lhalve the time between testing lock files when waiting for otherprograms to complete.  By default this is 8 seconds. For example-olll sets the interval to 1 second..TP 9.B     nignore requests for pages to be retransmitted. Use this option ifyou don't care about the quality of the received fax or if thereceiving machine is too fussy.  Otherwise each page may beretransmitted up to 3 times..TP 9.B     rdo not reverse bit order during data reception for Class 2modems.  Only Multitech modems require this option. Not normallyrequired since efax detects these modems..TP 9.B     xsend XON (DC1) instead of DC2 to start data reception.  Appliesto a very few Class 2 modems only..TP 9.B     zdelay an additional 100 milliseconds before each modeminitialization or reset command.  The initial delay is 100ms. For example, -ozzz produces a 400 ms delay.  Use with modemsthat get confused when commands arrive too quickly..TP 9.B -q \fIn\fPask for retransmission of pages received with more than \fIn\fPerrors.  Default is 10..TP 9.B -r \fIpat\fPeach received fax page is stored in a separate file.  The filename is created using \fIpat\fP as a strftime(3) format string.A page number of the form .001, .002, ...  is appended to thefile name.  If \fIpat\fP is blank ("") or no -r option is given adefault string of "%m%d%H%M%S" is used..\" If a file already exists, efax terminates with an error..TP 9.B -sremove lock file(s) after initializing the modem.  This allowsoutgoing calls to proceed when efax is waiting for an incomingcall.  If efax detects modem activity it will attempt to re-lockthe device.  If the modem has been locked by the other programefax will exit and return 1 (``busy'').  Normally a new efaxprocess is then started by init(8). The new efax process willthen check periodically until the lock file disappears andthen re-initialize the modem..TP 9 .B -t \fInum [file\fP...]  dial telephone number \fInum\fP and send the fax image files\fIfile\fP....  If used, this must be the last argument on thecommand line.  The telephone number \fInum\fP is a string thatmay contain any dial modifiers that the modem supports such as aT prefix for tone dialing or commas for delays.  If no file namesare given the remote fax machine will be polled. If no -targument is given efax will answer the phone and attempt toreceive a fax..TP 9.B -v \fIstrng\fPselect types of messages to be printed.  Each \fIlower-case\fPletter in \fIstrng\fP enables one type of message:.RS 12.Be - errors.br.Bw - warnings.br.Bi - session progress information.br.Bn - capability negotiation information.br.Bc - modem (AT) commands and responses.br.Bh - HDLC frame data (Class 1 only).br.Bm - modem output.br.Ba - program arguments.br.Br -reception error details.br.Bt -transmission details.br.Bf -image file details .br.Bx -lock file processing.RE.RS 9Up to two -v options may be used.  The first is for messagesprinted to the standard error and the second is for messages tothe standard output. The default is "ewin" to the standard erroronly..RE.TP 9.B -wwait for an OK or CONNECT prompt instead of issuing an answer(\fBATA\fP) command to receive a fax.  Use this option when themodem is set to auto-answer (using S0=\fIn\fP) or if anotherprogram has already answered the call..TP 9.B -x \fIlkf\fPuse a UUCP-style lock file \fIlkf\fP to lock the modem devicebefore opening it.  If the device is locked, efax checks every 15seconds until it is free.  Up to 16 -x options may be used ifthere are several names for the same device.  A `#' prefix on thefile name creates an binary rather than text (HDB-style) lockfile.  This is the reverse of what was used by previous efaxversions..SH FAX FILE FORMATSefax can read the same types of files as \fBefix(1)\fP includingtext, T.4 (Group 3), PBM, single- and multi-page TIFF (G3 anduncompressed).  efax automatically determines the type of filefrom its contents.  TIFF files are recommended as they containinformation about the image size and resolution.Each page to be sent should be converted to a separate TIFFformat file with Group 3 (G3) compression.  Received files arealso stored in this format.  The EXAMPLES section below shows howefix and other programs can be used to create, view and printthese files..SH OPERATING SYSTEM REQUIREMENTSThe operating system must provide short response times to avoidprotocol timeouts.  For Class 2 and 2.0 modems the delay shouldnot exceed 1 or 2 seconds.When using Class 1 modems the program must respond to certainevents within 55 milliseconds.  Longer delays may cause the faxprotocol to fail in certain places (between DCS and TCF orbetween RTC and MPS).  Class 1 modems should therefore not beused on systems that cannot guarantee that the program willrespond to incoming data in less than 55 milliseconds.  Inparticular, some intelligent serial cards and terminal serversmay introduce enough delay to cause problems with Class 1operation.The operating system must also provide sufficient low-levelbuffering to allow uninterrupted transfer of data between themodem and a disk file at the selected baud rate, typically 9600bps.  Since the fax protocol does not provide end-to-end flowcontrol the effectiveness of flow control while receiving islimited by the size of the modem's buffer. This can be less than100 bytes.  Efax does not use flow control during reception..SH MODEM REQUIREMENTSThe "Group" is the protocol used to send faxes between faxmachines.  Efax supports the Group 3 protocol used over thepublic telephone network.The "Class" is the protocol used by computers to control faxmodems.  Efax supports Class 1, 2 and 2.0 fax modems.Most fax modems use XON/XOFF flow control when in fax mode.  Thistype of flow control adds very little overhead for fax use. Manymodems have unreliable hardware (RTS/CTS) flow control in faxmode.  By default efax enables only XON/XOFF flow control and the-oh option must be used to add hardware flow control.While some modems have serial buffers of about 1k bytes, manyinexpensive modems have buffers of about one hundred bytes andare thus more likely to suffer overruns when sending faxes.A few older modems may need a delay between commands of more thanthe default value used by efax (100 milliseconds).  If the delayis too short, commands may not echo properly, may time out, ormay give inconsistent responses.  Use one or more \fB-oz\fPoptions to increase the delay between modem initializationcommands and use the E0 modem initialization command to disableechoing of modem commands.By default efax sends DC2 to start the data flow from the modemwhen receiving faxes from Class 2 modems.  A few older modemsrequire XON instead.  Use of DC2 would cause the modem to give anerror message and/or the program to time out.  The \fB-ox\fPoption should be used in this case.A few older Class 2 modems (e.g. some Intel models) don't sendDC2 or XON to start the data flow to the modem when sendingfaxes.  After waiting 2 seconds efax will print a warning andstart sending anyways.A very few Class 2 modems do not reverse the bit order (MSB toLSB) by default on receive.  This might cause errors when tryingto display or print the received files.  The \fB-or\fP option canbe used in this case.Some inexpensive "9600 bps" fax modems only \fItransmit\fP at9600 bps and reception is limited to 4800 bps.The following Class 1 modems have been reported to work with efax:AT&T DataPort,.\" Andrea Gozzi <work@forum.sublink.org>, v0.6, SCO 3.2.0, (Class 1)Cardinal Digital Fax Modem (14400),.\" awk0%navajo@gte.com, v0.6, linux 1.0, downloading fax144c.carDigicom Scout+,.\" umlin000@CC.UManitoba.CA, v 0.6, Linux 1.1.12Motorola Lifestyle 28.8,.\" mortbay@ozemail.com.auMotorola Power 28.8,.\" danz@wv.mentorg.com, Linux 1.2.10QuickComm Spirit II,.\" umlin000@CC.UManitoba.CA, v 0.6, Linux 1.1.12.\" gsmith@softsmiths.oz.au, v 0.7a, add "*F1" for Xon/XoffSmartlink 9614AV-Modem,.\" gt@sky.gun.de, v0.6, Linux 1.1.15Supra Faxmodem 144LC,.\" john@johncon.johncon.com, v0.6, Consensys (ie., Unixware) 4.2USR Courier V.32bis Terbo,.\" meyer@geomatic.no, v0.6, SunOS 4.1.3USR Sportster (V.32 and V.34),.\" satyr!kayvan@apple.com (Kayvan Sylvan), v0.6, Linux (?)Zoom AFC 2.400,.\" hausutzu@pse.panic.bln.sub.org (Utz-Uwe Haus), v0.6, LinuxZoom VFX14.4V..\" edc@ee.ubc.ca (me!), v0.6, LinuxThe following Class 2 modems have been reported to work with efax:14k4 Amigo Communion fax/modem,.\" bekker@tn.utwente.nl, efax0.5Adtech Micro Systems 14.4 Fax/modem,.\" gmaughan@grape.fcit.monash.edu.au, Linux 1.2.10, efax 07aaskey modem type 1414VQE,.\" thowi@chiba.escape.de, efax06?, Linux?AT&T DataPort,.\" ingber@alumni.caltech.edu (Class 2)ATT/Paradyne,.\" john@johncon.johncon.comAT&T Paradyne PCMCIA,.\" jh@datanet.tele.fi (Juha Heinanen)Boca modem,.\" ?BOCA M1440E, .\" v0.6a, SunOS 4.1.1, Linux 1.0.9.\" hsw1@papa.attmail.comCrosslink 9614FH faxmodem,.\" ?FuryCard DNE 5005,.\" a PCMCIA Class 3 faxmodem.\" ron@draconia.hacktic.nlGVC 14.4k internal,.\" jchen@ee.mcgill.ca, 0.6a w/ stty fax patch, Linux kernel 1.1.59Intel 14.4 fax modem,.\" (matloff@cs.ucdavis.edu)Megahertz 14.4,,\" norman@bellcore.comMicrocom DeskPorte FAST ES 28.8,.\" Skip Montanaro (skip@automatrix.com), 0.6a, Linux