background image

Keyword reference

XFAX - User’s Guide 4.3a

54

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 argu-
ment -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. Possi-
ble 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

Summary of Contents for XFAX

Page 1: ...Nordic Messaging Technologies Sweden http www nordicmessaging se info nordicmessaging se XFAX User s Guide 4 3a ...

Page 2: ... 6 1 Fax queues 19 6 2 Reschedule a fax 20 6 3 Scheduling a fax 20 6 4 Canceling of a fax 20 6 5 Printing a fax 21 6 6 Listing faxes in a particular directory 21 6 7 Routine maintenance 21 6 8 Cleaning the statistics file 22 7 XFAX in a Windows environment 23 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 Overla...

Page 3: ...4 15 1 4 ACCEPT_USERS 44 15 1 5 ADMINISTRATOR 44 15 1 6 ALERT_USER 44 15 1 7 ARCHIVE_SENT 44 15 1 8 AUTOPRINT 44 15 1 9 BROKEN_SELECT 45 15 1 10 BUSY_FAIL 45 15 1 11 CHARACTER_SET 45 15 1 12 CLASS 45 15 1 13 CODE_END 45 15 1 14 CODE_START 45 15 1 15 COMPANY 45 15 1 16 DEBUG 46 15 1 17 DEFAULT_FONT 46 15 1 18 DEFAULT_MARGIN 46 15 1 19 DENY_USERS 46 15 1 20 DIAL_PREFIX 46 15 1 21 DEFAULT_PRINTER 46 ...

Page 4: ... 52 LP_PRINT_OPTION 52 15 1 53 MAIL_ON_ERROR 52 15 1 54 MAIL_ON_SUCCESS 52 15 1 55 MAX_BPS 52 15 1 56 MAX_TRIES 52 15 1 57 NICE_CONV 52 15 1 58 NICE_SEND 52 15 1 59 NO_ERROR_SAVE 53 15 1 60 NO_STATISTICS 53 15 1 61 OLD_SCO 53 15 1 62 PARTIAL_PAGES 53 15 1 63 PORT 53 15 1 64 PRINT_REC_TO_LEFT 53 15 1 65 PULSE 53 15 1 66 QUIET 53 15 1 67 RECEIVE_ONLY 54 15 1 68 RESOLUTION 54 15 1 69 RETRY_TIME 54 15...

Page 5: ...E 56 15 1 85 USE_SHM 56 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 ...

Page 6: ...ple way it automati cally follows that the whole system is easy to administer The XFAX directory structure appears in the form shown below the symbolic names of the various directories are used throughout this manual ETCDIR System files configuration messages statistics etc Can be changed by setting the environment variable XFAXDIR The default directory is etc xfax FONTDIR Font files Changed in th...

Page 7: ...OOLDIR 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: ...e root directory cd Extract the archive xfax42aix tar for AIX for example tar xvf xfax42aix tar Execute the installation script sh tmp xfax INSTALL 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...

Page 9: ...g for modem XON_XOFFSpecifies XON XOFF flow control is to be used FLOWFLOW 0 specifies do not try CTS RTS flow control EXECUTE_AFTER_SENDSpecify a program to be executed after transmission MAX_RETRIESMaximum number of tries to send a message RETRY_TIMETime in minutes between tries ROUND_ROBINUsed with multiple modem devices There are more than 100 different keywords used by XFAX 3 2 Environment va...

Page 10: ...wing FAXLINE tty1 tty2 By default XFAX when sending a fax tries to use the first line specified by the FAXLINE keyword and if that one is busy it tries with the next one You can use the keyword ROUND_ROBIN to make XFAX use the fax lines in a round robin manner This means that it alternates between the line in a cyclic way The first line specified is used for the first fax then line number two and ...

Page 11: ...Configuring the software XFAX User s Guide 4 3a 11 ...

Page 12: ...he fax format and asks the fax server to place the final fax in a queue awaiting transmission When the time for transmit ting is reached normally immediately an attempt is made to send the fax If the transmission is successful the fax is removed from the transmission queue and the statistic is saved in the statistics file On the other hand if the attempt is not successful the fax is given a new ti...

Page 13: ...number corresponds with that which is defined by LOCAL_PREFIX in the configuration file it is automatically removed before the fax is placed in the queue This means that it is possible to always give the area code e g in the telephone book without any problems aris ing during transmission 4 2 Attaching a note to a fax In order to be able to keep track of which fax is which a note of a maximum of 8...

Page 14: ...t perhaps to minimize telephone costs 4 5 The ID of the fax in the queue Each fax is given its own unique identity number before being placed in its respective queue When being transmitted the fax s ID can be shown on the screen after the fax has been placed in the queue by giving the parameter id to faxsend It can look like this faxsend id 7586535 letter Converting files OK Placing fax in queue O...

Page 15: ... if so required Windows clients also use the telephone books in the system Note If an area code given in the telephone number corresponds with that which is defined by LOCAL_PREFIX in the configuration file it is automatically removed before the fax is placed in the queue This means that it is possible to always give the area code e g in the telephone book without any problems aris ing during tran...

Page 16: ...arated with semi colons or colons SYMBOL_SET id Indicates that the symbol set id should be used For lists of permitted val ues see the Appendix Commands faxsend CHAR_SET id Indicates that the character set id should be used For lists of permitted values see Appendix Command reference faxsend TIME tt mm Indicates at what time the transmission of the fax should start 4 10 The telephone cost file ETC...

Page 17: ...certain countries to which you often ring the cost can be specified exactly as for USA in the example above If the line with 009 ABROAD had not been there with the above a number which began with e g 00949 Germany would not have been able to be matched against any line in the table and consequently would have been considered as a local call ZONES time 1 time 2 Here the tariff zones that are to be ...

Page 18: ...o necessary is that the reception function is included in your license agreement and that the keywords SEND_ONLY are not shown in the configura tion file ETCDIR config 5 1 Automatic printing of incoming faxes Incoming faxes can be automatically sent to a printer by defining the keyword AUTOPRINT in the configuration file The format is AUTOPRINT com mand whereby command is something which can recei...

Page 19: ... Fax number Enqueued Next St P Try LC User Pgs 14 55576861 11 01 19980430 11 41 SE 4 1 BUSY stenor 1 15 04012345 11 33 19980430 11 33 PE 4 1 NOAN davcar 3 Infoflex System AB Lars 18 55576861 11 45 19980430 11 45 PE 4 2 davcar 1 The information that is in the columns above is in sequence The Fax s ID number the recipient s fax number the time and date when the fax was placed in the queue the time f...

Page 20: ...hanges the transmission time for a fax with an ID of 16 to 12 18 6 4 Canceling of a fax A fax can be cancelled i e removed from the outgoing fax queue by means of the command faxrm which takes one or several IDs as an argument E g faxrm 28 12 removes faxes with IDs 12 and 28 Faxrm is also used to remove a fax from the statistic queues for sending and faulty faxes When canceling such faxes the fax ...

Page 21: ...n the queue In order to list the faxes that are in this or some other directory the parameter d is used to faxq When this parameter is used alone files in HOME Fax are shown E g faxq d Directory Fax ID Fax number Sec Try Time LC User Pgs 14 55576861 2 3 11 01 19980601 BUSY stenor 2 The command searches for files which have a name beginning with S and R and which are recognized as XFAX files The in...

Page 22: ... a considerable size In order to remove parts of the contents of this file the command faxclean is used As an argument for faxclean it can be indicated that information up to and including a particular date should be removed in the following way faxclean to 19980420 Note that faxclean must be run on the machine where the statistics file is kept i e where XFAXDIR is to be found The user who runs fa...

Page 23: ...e self installing file Fill out the host and port configuration to match the fax server configuration Done Now there is a printer available known as XFAX on XFAX 7 1 2 Using the client If you want to send a document from Microsoft Word for example you open the document in Word and choose Print In the print dialog choose the XFAX printer When you click OK the XFAX client will connect to the server ...

Page 24: ... 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 ...

Page 25: ...pany logo to outgoing purchase orders or to add a nice layout in an e mail to fax gateway for example 8 2 Cover sheets the old way It is quite easy to make neat cover sheets page headings and page footings in XFAX with logotypes and other refinements The principle is that you design your cover sheet or whatever in some suitable program which can make a print out in the form of PCL code to be more ...

Page 26: ...pecial field codes MESSAGE Replaced with the contents in the file which is indicated as an argument E g MESSAGE tmp message insert the file tmp message instead of the code DATE The current date is inserted The format is yyyy mm dd TIME The current time is inserted The format is tt mm Note that the script xfax automatically searches for a file cover under ETC DIR If this file is there it will be us...

Page 27: ...rlay files and cover sheets XFAX User s Guide 4 3a 27 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 ...

Page 28: ...nges to any name servers The configuration file for sendmail is known as sendmail cf and is generally to be found under etc or usr lib Furthermore we presuppose that the software is installed so that BINDIR is usr local xfax bin and that ETCDIR is usr local xfax etc A tip is to copy sendmail cf to e g sendmail xfax and then make the changes in this After having verified that the new rules which ha...

Page 29: ... 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 Set up any cover sheet address filter to prevent unauthorized people usin...

Page 30: ...r s Guide 4 3a 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 ...

Page 31: ...rm We do not provide support for the Ghostscript software itself 2 Download and store the XFAX source files gdevxfax c and gdevxfax h into opt gs7 00 src You can get the files from ftp ftp infoflex se pub xfax ghost script 3 When you compile Ghostscript you use one of the supplied makefiles we use src unixansi mak You need to modify the makefile to include the XFAX driver Add DD xfaxhigh dev to th...

Page 32: ...USE sDEVICE xfaxhigh sOutputFile test fax test pdf faxsend 12345 test fax 10 2 Troubleshooting If you are expebriencing problems there are two common mistakes to be men tioned here 1 You should run make f src unixansi mak install so that the files Ghostscript needs is placed in the proper locations Among other files gs looks for gs_init ps in usr local share ghostscript 7 00 lib 2 You need the fon...

Page 33: ...ail You need to enable the HTTP server in order to use it see HTTP_ENABLE The default port the server listens to is 7180 this can be changed using HTTP_PORT in the config file If the server is enabled and is using the default port point your browser to http hostname 7180 In order to limit access to the HTTP server you can specify hosts or networks that can access the server see ACCESS_HTTP You can...

Page 34: ... 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 In order to limit access to the SMTP server you can specify hosts or networks that can access the server see ACCESS_SMTP You can also specify users and password using USER_FILE Keywords used by the SMTP server SMTP_ENABLE SMTP_PORT ACCESS_SMTP USER_FILE ...

Page 35: ...rol it is very efficient It is quick and reliable even for communication at high speeds Variant number two XON XOFF is based on another principle For this two ASCII characters XON hex 0x13 and XOFF hex 0x11 are chosen as control characters and these are used to control the data flow When transmitting from computer to modem the modem sends the character XOFF to show that the buffer is or is close t...

Page 36: ...s are available in XFAX 14 1 Commands 14 1 1 faxadm Syntax faxadm Script which gives the user a simple text based menu for the administration of his her fax environment 14 1 2 fax2bmp Syntax fax2bmp Converts a fax file to bitmap format This functionality will be extended 14 1 3 fax2hp Syntax fax2hp Converts a fax file to HP Laserjet format PCL code Used by faxmaster and faxprint for printing out f...

Page 37: ...the program version and syntax debug Means that information on events during program run ning are written to standard out r Shows the return codes from the various fax com mands xdb Display more detailed debug information This is the fax server which does all work on behalf of its clients and users The fax host maintains fax queues checks authority and licence information and reads data control an...

Page 38: ...ore pid in the file name 14 1 9 faxprint Syntax faxprint q d printer ID ID file Used to print out a fax on an HP Laserjet compatible printer Parameters v Shows the program version and syntax q Does not write information to the screen d printer Specifies that the printout will be sent to the stated printer The argument can be either a fax ID or the name of a fax file The printout data is sent to th...

Page 39: ...r of retries for sent and faulty faxes 14 1 11 faxrm Syntax faxrm all queue to date ID ID ID Used to cancel a fax that is in a queue for outgoing faxes Furthermore you can mark sent and faulty faxes that have been removed to avoid having a mass of old faxes when you look through your queues However the statistics are kept Parameters all queue Indicates that all the faxes in the queue indicated sho...

Page 40: ...e symbol margin n Sets the default margin af the fax to 5 characters See also DEFAULT_MARGIN n string Ties a note string to the fax This note is then shown in the fax queues Maximum length is 80 characters p priority Indicates that the fax should have a certain priority Normally 4 Permitted values are 1 7 1 indicates the highest priority q Does not write information to the screen quiet s id Choose...

Page 41: ...ty graph i e how many faxes are in the queue at different times of the day This function can be used to see where the largest telephone costs are and possibly do something about this by locating fax transmissions to those times of the day when the tele phone tariff is lowest s string Selection string which describes which data should be included in the report Example faxstat s date 960120 960125 I...

Page 42: ...2 Exit codes The client programs use the following exit codes 2 Error in serialisation file 3 Error in configuration file 4 Invalid argument 6 Could not connect to faxmaster 13 Invalid recipient 16 Could not read recipients file 52 Out of disk space ...

Page 43: ... 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...

Page 44: ...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 ...

Page 45: ...e 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 1...

Page 46: ... 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 spe cific users See also ACCEPT_USERS 15 1 20 DIAL_PREFIX DIAL_PREFIX string Gives the prefix ...

Page 47: ...ND 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 Con nect 2 Ring 3 No carrier 4 Error 6 No dial tone 7 Busy 8 No answer 19 No l...

Page 48: ..._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 key word this directory can be freel...

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

Page 50: ...t 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 51: ...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 ...

Page 52: ...nt 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 sen...

Page 53: ... 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 val...

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

Page 55: ...o 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 hos...

Page 56: ... 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 communica tion Not all platforms support Shared Memory 15 1 86 USER_FILE USER_FILE filename Specifies a file to us...

Page 57: ...l 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 send ing a fax Note that INIT_STRING must be set in conformity with this ...

Page 58: ...e In the delivery medium the files are packed with the UNIX command compress The file name then ends with a Z The files should be unpacked during instal lation If it has not been possible to do this it should be done manually by going into the directory where the files are located and writing compress d All users must have the right to read typeface files and to read and search in the directory wh...

Page 59: ...control should be used Begin by setting up the system for XON XOFF This is generally the easiest way to get started In order to run RTS CTS flow control an initiation string should be used which sets up the modem for RTS CTS In addition it is necessary that the serial port is set up for and can handle RTS CTS This method is to be preferred but is not supported by all serial cards There is a proble...

Page 60: ...mpressing this type of data 17 3 Memory required This depends to some extent on the operative system but the whole system occu pies between 2 Mb of memory after installation When using the system the fol lowing is added One fax file with a normal page of data A4 needs between 20 and 80 kb 17 4 Tested platforms AIX 3 2 5 AIX 4 1 AIX 4 2 AIX 4 3 HP UX 9 x HP UX 10 x HP UX 11 x Linux Redhat SCO OpenS...

Page 61: ...th their respective escape sequences Courier 10 cpi ESC s0p0b0s0t10H Line Printer 16 6 cpi ESC s0p0b0s3t16 6H Helvetica 8 pt ESC s1p0b0s4t8V Helvetica 10 pt ESC s1p0b0s4t10V Helvetica 12 pt ESC s1p0b0s4t12V Helvetica 10 pt italics ESC s1p0b1s4t10V Helvetica 12 pt italics ESC s1p0b1s4t12V Helvetica 10 pt bold ESC s1p3b0s4t10V Helvetica 14 pt bold ESC s1p3b0s4t12V Helvetica 14 pt bold ESC s1p3b0s4t1...

Page 62: ...sing 25 D document codes using 15 G Ghostscript using with XFAX 31 H Handling faxes printing 21 rescheduling 20 scheduling 20 O Overlays using 25 P PDF sending documents 31 S sendmail integrating with 28 W Windows client using 23 X XFAXDIR defined 7 ...

Reviews: