XFAX 4.3a - User's Guide
14. Command reference
Here we describe the syntax of each command in the software. You can use -v as an option for most of the commands to get syntax information for the command. 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.
The following command-line utilities are available in XFAX.
Script which gives the user a simple, text-based, menu for the administration of his/her fax environment.
Converts a fax file to bitmap format. This functionality will be extended.
Converts a fax file to HP Laserjet format (PCL code). Used by faxmaster and faxprint for printing out faxes.
Syntax: faxclean [-older days] [-to date]
Used to clean out the statistics file.
Syntax: faxlogon [-q] [-u user]
Used for connection to the fax server, faxmaster.
The user cannot utilize the services of the fax system before he/she is connected to the fax host via faxlogon. When the maximum number of users in accordance with the licence agreement has been reached, faxlogon will deny any new users connection to the fax host.
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".
Syntax: faxmaster [-debug] [-xdb] [-r] [-v]
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 and statistic files. Faxmaster is normally started from one of the initiation scripts (rc-files) which are run when the system is started up. After this it remains in the background and doing its job without any fuss. Any fault messages are written out in the file ETCDIR/Log/faxmaster.
Faxmaster must be restarted when the configuration file, ETCDIR/config, or the serializing file, ETCDIR/.serial, are modified.
Syntax: faxmime [-e | -file]
Used to extract information from a file on the MIME format. The result is written on stdout and consists partially of codes and partially of the file name with the extracted attachments. The following codes can occur:
Files which are created are called <pid>.<seqno>.<ext> where the seqno is the enclosure's sequence number in the file, ext is the file's extension, which can for example be txt for a text file, and pid is the processor's id and is guaranteed to be unique.
You can then choose which enclosures you want to use and which ones you wish to discard.
Syntax: faxprint[-q] [-d printer] [ID [ID ...] | file]
Used to print out a fax on an HP Laserjet compatible printer.
The argument can be either a fax-ID or the name of a fax file. The printout data is sent to the standard printer if no special printer is specified. The printer should be HP Laserjet compatible and the data must not be filtered, i.e. the printout should be raw, otherwise it will be garbage. E.g. faxprint -d LASER 13 or faxprint D.510.000.
Syntax: faxq [-reverse] [ -p | -s | -r | -f | -d [directory] [ -h ID ] [ -n ID ] [ -t tt:mm ID] [-x]
Used to show the various fax queues, to change the sending times for a special fax and to list fax files.
If there is no argument, the program looks in the directory Fax under the user's home directory ($HOME). The information listed is, in sequence: ID, the recipient's fax number, the number of seconds connected, the number of retries, the time the fax has been in the queue and the number of fax pages. Note that you must have authority to read the directory in question.
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.
You find out the ID of a fax by using the command faxq. Several faxes can be cancelled at the same time by giving several IDs separated by a space.
Syntax: [-c id] [-s id] [-l file name] [-n note] [-p priority] [-t tt:mm] [-u user] [-d printer] [-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.
0 (US), 1 (French), 2 (German), 3 (UK), 4 (Danish), 5 (Swedish), 6 (Italian), 7 (Spanish), 8 (Japanese), 9 (Norwegian), 10 (Danish 2) and 11 (Spanish 3).
The standard values are given by the keywords CHARACTER_SET in the configuration file.
1 Latin-1 (ISO 8859-1)
The standard value is given by the keywords SYMBOL_SET in the configuration file.
Syntax: faxsr infile [-]
Used to make a search & replace in HP Laserjet files. See further details in the chapter XFAX and cover sheets.
Syntax: faxstat [-g] [-v] [-s string]
Used to generate statistics reports and to show activity graphs.
If no parameter is given, statistics of the number of faxes in the queue are shown, plus the number of unsuccessful faxes, the connected time and the cost for the call in accordance with the tariff tables in the file ETCDIR/cost.
Syntax: faxwho [-u]
Used to find out which users are connected to faxmaster and from which tty: or IP addresses they are logged in.
14.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