Table of Contents

Advertisement

Quick Links

XFAX
User's Guide 4.3a
Nordic Messaging Technologies, Sweden, http://www.nordicmessaging.se, info@nordicmessaging.se

Advertisement

Table of Contents
loading

Summary of Contents for Nordic Messaging Technologies XFAX

  • Page 1 XFAX User’s Guide 4.3a Nordic Messaging Technologies, Sweden, http://www.nordicmessaging.se, info@nordicmessaging.se...
  • Page 2: Table Of Contents

    7.1 The XFAX Windows client (printer driver)........23 7.1.1 Installation................23 7.1.2 Using the client ................23 7.2 Using the address book in XFAX .............23 8. Overlay files and cover sheets..............25 8.1 Using overlay files as forms and cover pages ........25 8.2 Cover sheets the old way..............25 9.
  • Page 3 15.1.19 DENY_USERS ..............46 15.1.20 DIAL_PREFIX ..............46 15.1.21 DEFAULT_PRINTER............46 15.1.22 DIAL_TIMEOUT ..............46 15.1.23 DOMAIN ................47 15.1.24 EXEC_WORKDIR ..............47 15.1.25 EXECUTE_AFTER_RECEIVE..........47 15.1.26 EXECUTE_AFTER_SEND ..........47 15.1.27 EXECUTE_BEFORE_SEND..........48 15.1.28 EXIT_STRING ..............48 15.1.29 FAIL_DIR................48 15.1.30 FAIL_FAXNO ..............48 15.1.31 FAXHOST ................48 XFAX - User’s Guide 4.3a...
  • Page 4 15.1.67 RECEIVE_ONLY..............54 15.1.68 RESOLUTION..............54 15.1.69 RETRY_TIME..............54 15.1.70 REVERSE_STATS..............54 15.1.71 ROUND_ROBIN ..............54 15.1.72 SEND_BPS ................54 15.1.73 SEND_ONLY ..............55 15.1.74 SMTP_ENABLE ..............55 15.1.75 SMTP_PORT ...............55 15.1.76 SMTP_SENDER..............55 15.1.77 SMTP_SERVER..............55 15.1.78 SPOOLDIR ................55 15.1.79 STTY..................55 15.1.80 SYMBOL_SET..............56 15.1.81 T30_ECM................56 XFAX - User’s Guide 4.3a...
  • Page 5 15.1.86 USER_FILE .................56 15.1.87 WAIT_FOR_TONE.............57 15.1.88 XON_XOFF.................57 16. Troubleshooting..................58 17. Technical specifications ................60 17.1 Modem drivers ................60 17.2 File formats ..................60 17.3 Memory required................60 17.4 Tested platforms................60 17.5 Modems tested ................60 17.6 Typefaces in XFAX ................61 XFAX - User’s Guide 4.3a...
  • Page 6: Overview

    In addition, the system uses /tmp for temporary files plus, depending on the oper- ating system, /usr/spool/uucp, /usr/spool/locks or /etc/locks for locking files in combination with communication. We use the following symbolic names for the various directories used by XFAX throughout the documentation. XFAX - User’s Guide 4.3a...
  • Page 7 Overview XFAXDIR Directory for the configuration files (default is /etc/xfax) SPOOLDIR Directory for messages in the outgoing queue (default is /usr/spool/xfax) BINDIR Directory for the executables (default is /usr/bin) Some important files: XFAXDIR/config Configuration file XFAXDIR/stats Statistics file XFAXDIR/LCK.faxmaster The faxmaster lock file that indicates the faxmaster is running...
  • Page 8: Installation

    Check the installation by running faxmaster -v which should display software information provided that: a. /etc/xfax is used for the configuration files or the variable XFAXDIR is set to the directory used. b. The directory for the executables is included in PATH.
  • Page 9: Configuring The Software

    Configuring the software 3. Configuring the software The behavior of XFAX is mainly controlled by a number of keywords used in the configuration file, config. You can alter the way XFAX acts by modifying config and then restart faxmaster. You restart the faxmaster by finding the process id, kill the process and then start the daemon again.
  • Page 10: Adding Actions

    The specified program will be called with a number of parameters. 3.4 XFAX and multiple fax devices To use multiple fax devices, or fax lines, with XFAX first of all you need an XFAX license that permits multiple lines. You can display the number of lines your current license permits using faxmaster –v.
  • Page 11 Configuring the software XFAX - User’s Guide 4.3a...
  • Page 12: Sending A Fax

    Plus printer. This means that HP Laserjet printouts from within another program such as a word processor can be sent direct to XFAX with precisely the same results as if they had been printed out on the laser printer. The only difference is that the resolution on a fax is 200 dpi (dots per inch) as opposed to a laser printer’s 300 dpi or more.
  • Page 13: Attaching A Note To A Fax

    -l with the file name is used as an argument. Lines which begin with the symbol # are missed out and can thereby be used for comments. E.g.: # faxsend –l customerfax news.txt XFAX - User’s Guide 4.3a...
  • Page 14: Scheduled Transmissions

    OPTION and DEFAULT_PRINTER in the configuration file are used. 4.7 The script xfax Accompanying the XFAX distribution is a small command script known as xfax, which can be found under BINDIR. This command is for sending a fax, together XFAX - User’s Guide 4.3a...
  • Page 15: The Script Faxadm

    You can also set up a telephone book to use together with xfax. Not only can glo- bal telephone books be arranged for all users of XFAXDIR/faxdir but personal telephone books can also be set up for each user in the directory .faxdir under the...
  • Page 16: The Telephone Cost File Etcdir/Cost

    Windows. An XFAX cannot interpret this. The typefaces which can be used are those which are included in a Microsoft Z1A font cassette and they are indicated in font lists in Windows with a small printer.
  • Page 17 However, the same name must of course be used in the AREA_CODES section so that the right area code can be paired with the right cost. XFAX - User’s Guide 4.3a...
  • Page 18: Receiving Faxes

    E.g.: AUTOPRINT=”| lp -d LASER” this takes the printer data and sends it on to the 1p command via a pipe. The data can also be saved in a file or similar by AUTOPRINT=”>>/tmp/file” XFAX - User’s Guide 4.3a...
  • Page 19: Handling Faxes

    Holding The latest status codes can be: BUSY Busy NOAN No answer NOCA The link was broken before connection was made (no carrier) NODT No dial tone LINE Communication with the modem is not functioning XFAX - User’s Guide 4.3a...
  • Page 20: Reschedule A Fax

    These can also be combined, e.g. faxq -all sf. If you wish to remove all faxes up to a certain date, you use -all in combination with -to date. E.g.: # faxq -all s -to 20010401 XFAX - User’s Guide 4.3a...
  • Page 21: Printing A Fax

    The command searches for files which have a name beginning with S. and R. and which are recognized as XFAX files. The information that is listed includes the recipient’s fax number, the time when the fax was first placed in the queue plus the name of the user who placed the fax in the queue.
  • Page 22: Cleaning The Statistics File

    XFAXDIR is to be found. The user who runs faxclean must also have the authority to read and write in the file, which is normally only the system administrator (root). This command can, to advantage, be run automatically once a day or similar using cron. XFAX - User’s Guide 4.3a...
  • Page 23: Xfax In A Windows Environment

    "0855576861","Infoflex Connect","Fredrik Nilsson" "faxnr","Company","recipient" "faxnr","Company","recipient" and so on.. You can then import this file in the XFAX-dialog. 2) Put a file in the /etc/xfax/faxdir on the server side. The file has to have the following content: XFAX - User’s Guide 4.3a...
  • Page 24 XFAX in a Windows environment 1: 0855576861:Fredrik Nilsson:Infoflex Connect 2:faxnr:recipient:company 3:faxnr:recipient:company 3) Put a file in the users home-catalog/.faxdir on the server. The file has to have the following content: 1: 0855576861:Fredrik Nilsson:Infoflex Connect 2:faxnr:recipient:company 3:faxnr:recipient:company XFAX - User’s Guide 4.3a...
  • Page 25: Overlay Files And Cover Sheets

    Overlay files and cover sheets 8. Overlay files and cover sheets Overlay files are files store in the XFAX fax format which can be used as cover pages or merge on to each fax page sent as a form template for example. This makes it possible to send faxes with a very nice layout.
  • Page 26 If this file is there it will be used as a cover sheet. You are welcome to look in xfax to find what field names have been used for the call to faxsr. There are some things you may need to change in the PCL file, namely: The symbol set up, XFAX wants to have Latin-1.
  • Page 27 Overlay files and cover sheets Last but not least. You are welcome to contact your retailer or Nordic Messaging Technologies if you need any help in setting up and using cover sheets./ XFAX - User’s Guide 4.3a...
  • Page 28: Xfax And E-Mail

    XFAX and e-mail 9. XFAX and e-mail XFAX can be used, to advantage, as a fax gateway in a system for electronic mail. By addressing your letters in a special way you can send both fax and elec- tronic mail from one and the same program, the mail client.
  • Page 29: The Script Faxmail

    When we execute the command we obtain a prompt. There we write in: S3 55576861.fax@infoflex.se Check that the mail is in a queue in XFAX. If this does not work it is only neces- sary to write out the log message at a strategic place in faxmail. Note that you can use the special shell variable $? which always contains the return code for the command last executed.
  • Page 30 Mount the message on a cover sheet. You may possibly wish to have different cover sheets for various departments or similar. Place the fax in a queue with the aid of faxsend. Report back on any problems via mail. XFAX - User’s Guide 4.3a...
  • Page 31: Xfax And Ghostscript (Sending Pdf And Postscript)

    You can learn more at www.ghostscript.com. Below you find instructions of how to add a XFAX driver to Ghostscript 7.00, which today (june 2001) is the latest version of Ghostscript. The procedure does require knowledge on how to configure and compile a C source code distribution in a UNIX environment.
  • Page 32: Troubleshooting

    5. I the above works out OK, you should now be able to fax Postscript and PDF files. If you are using XFAX 4.2a or later faxsend directly supports files with .ps and .pdf suffix respectively. Please note that faxsend requires the Ghostscript executable, gs, to be in the PATH and properly configured.
  • Page 33: The Integrated Http Server

    The integrated HTTP server 11. The integrated HTTP server XFAX features an integrated HTTP server, which makes it possible to use a browser and to send a fax, display faxes, display queues etc. It is also possible to forward a fax as e-mail where the actual fax pages will be JPEG attachments in the e-mail.
  • Page 34: The Integrated Smtp Server

    The integrated SMTP server 12. The integrated SMTP server XFAX features an integrated SMTP server, which makes it possible to send a fax via SMTP. You need to enable the SMTP server in order to use it (see SMTP_ENABLE). The default port the server listens to is 7181, this can be changed using SMTP_PORT in the config file.
  • Page 35: Modems And Flow Control

    The support for CTS/RTS also varies from one operative system to another. On AIX it is often easy to get started. It is also satisfactory in those cases where serial cards are used which enable CTS/RTS to be set with stty parame- ters, e.g. DigiBoard. XFAX - User’s Guide 4.3a...
  • Page 36: Command Reference

    To get debug information, especially good for faxmaster, use -debug or -xdb. All scripts supplied with XFAX are example scripts of which the functionality is not guaranteed. However, the intention with these scripts is that they should be as complete as possible and improvements are being made on a regular basis.
  • Page 37: Faxmail

    14.1.6 faxmail Syntax: faxmail Script which is used on integration with mail software, e.g. sendmail. Faxmail is described in more detail in the chapter “XFAX connected to mail”. 14.1.7 faxmaster Syntax: faxmaster [-debug] [-xdb] [-r] [-v] Parameters: Shows the program version and syntax.
  • Page 38: Faxprint

    ID] [-x] Used to show the various fax queues, to change the sending times for a special fax and to list fax files. Parameters: Shows the program version and syntax. Shows the queue of outgoing faxes. XFAX - User’s Guide 4.3a...
  • Page 39: Faxrm

    [-q] fax number [file 1 [file 2...] | - ] Converts a HP Laserjet file to fax format and sends information on the fax to the fax server which then takes care of the actual transmission. Parameters: XFAX - User’s Guide 4.3a...
  • Page 40 Gives a particular time when the fax is to be sent. In normal cases the fax is sent as soon as possible, but with this parameter the transmission can be postponed. The time is given in hours and minutes, e.g. faxsend -t 12:34 7586535 faxfile. XFAX - User’s Guide 4.3a...
  • Page 41: Faxsr

    14.1.13 faxsr Syntax: faxsr infile [-] Used to make a search & replace in HP Laserjet files. See further details in the chapter XFAX and cover sheets. Parameters: If this parameter is given, the program reads the data from standard input instead of the stated files.
  • Page 42: Exit Codes

    14.2 Exit codes The client programs use the following exit codes: Error in serialisation file Error in configuration file Invalid argument Could not connect to faxmaster Invalid recipient Could not read recipients file Out of disk space XFAX - User’s Guide 4.3a...
  • Page 43: Keyword Reference

    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 XFAX - User’s Guide 4.3a...
  • Page 44: Access_Smtp

    HP Laserjet compatible printer. E.g.: AUTOPRINT=”½ 1p -dLASER”. The com- mand is executed automatically when the system has received a fax. XFAX - User’s Guide 4.3a...
  • Page 45: Broken_Select

    Keyword reference 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.
  • Page 46: Debug

    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 XFAX - User’s Guide 4.3a...
  • Page 47: Domain

    The number of seconds connected during the transmis- sion 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. XFAX - User’s Guide 4.3a...
  • Page 48: Execute_Before_Send

    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.
  • Page 49: Faxno

    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.
  • Page 50: Init_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.
  • Page 51: Ld_Prefix

    Indicates which type of locked files should be created when locking fax lines. This is dependent on the operating system. Values: Linux System V.4 HP-UX 15.1.51 LP LP=string Indicates which command should be used when printing out a fax. XFAX - User’s Guide 4.3a...
  • Page 52: Lp_Print_Option

    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. XFAX - User’s Guide 4.3a...
  • Page 53: No_Error_Save

    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.
  • Page 54: Receive_Only

    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.
  • Page 55: Send_Only

    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.
  • Page 56: Symbol_Set

    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 XFAX - User’s Guide 4.3a...
  • Page 57: Wait_For_Tone

    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 send- ing a fax. Note that INIT_STRING must be set in conformity with this. XFAX - User’s Guide 4.3a...
  • Page 58: Troubleshooting

    This is most probably a problem with regard to authority. Go through the various files and libraries which XFAX uses and check the owner and rights. Converting a fax is not successful Are the typeface files in the right place, unpacked and with the right authority? The program looks for files by looking at what FONTDIR is set at in the config- uration file.
  • Page 59 The program is compiled on a HP 9000/712 and as standard tries to set up hard- ware flow control. This is not always so satisfactory on HP’s server machines. Therefore you can shut off “the hardware control attempt” by adding FLOW = 0 in the configuration file. XFAX - User’s Guide 4.3a...
  • Page 60: Technical Specifications

    Technical specifications 17. Technical specifications XFAX is fax software for sending Group 3 faxes with the aid of Class 2-compat- ible fax modems. The maximum speed for sending faxes is 14.400 bps, however 9.600 bps is the most common. This depends on the other fax unit. The speed of computer to modem is 19.200 bps.
  • Page 61: Typefaces In Xfax

    The ports should be equipped with UART 16550 or similar circuits with buffering. Intelligent cards such as Digi- Board are equipped with such circuits. 17.6 Typefaces in XFAX The following typefaces are built into XFAX with their respective escape sequences: Courier 10 cpi <ESC>(s0p0b0s0t10H Line Printer 16.6 cpi...
  • Page 62 Index sendmail integrating with Cover sheets using Windows client using document codes using XFAXDIR defined Ghostscript using with XFAX Handling faxes printing rescheduling scheduling Overlays using sending documents XFAX - User’s Guide 4.3a...

Table of Contents