SquirrelFax 1.0 README
1 Scope of the project
This project is to design a fax application for use with Gnome. The program works as a front-end for mgetty+sendfax or hylafax to view and manage sent and received faxes, as interface with openoffice.org for sending faxes, and (future plan) as a means to send a simple one-page coverpage fax. It includes support for the complete configuration of mgetty+sendfax, and limited configuration (user level mainly) for hylafax.
2 Features of version 1.4
- Give an overview of sent and received faxes
- Show current outgoing queue
- Working phone configuration
- Can handle phone numbers in international format, being +<country code> <area code> <fax number>. If the given phone number does not start with a + it is dialed as entered.
- IDD code (usually 00) and area dial code (what has to be added to the area code, usually 0) are configurable.
- acts as pop-up when file name(s) are given on the command line.
- view sent and recieved faxes in gv (uses ps format)
- can save files in pdf format
- can resend received files to single or multiple recipient
- can send ps and pdf files to single or multiple recipient
- can send multiple ps or pdf files to single or multiple recipient in single fax (via the command line only).
- addressbook support: can read both Gnomecard and Evolution addressbook files (configurable which one to use, or none, or both - does simple dupe name checking)
- support for mgetty+sendfax (fully supported) and hylafax (beta level) agents
- support for starting/stopping fax services
- fax printer from OpenOffice.org
- when new fax received, can print the fax to configurable printer.
- when new fax received, can e-mail the fax as pdf, pbm (gzipped) or jpeg attachment to configurable e-mail address.
- when new fax received, can save the fax as pdf, ps, pbm or jpg file to your hard disk.
- supports user-only installation (no root password required, all files and configuration is stored in the user's home directory).
- set fax priority
- set fax send time (experimental)
- Gnome2 interface (experimental)
3 Useage
To simply send a fax, run "SquirrelFax <File name1> [<File name 2> ...]. SquirrelFax will display a pop-up window, and ask for the fax number(s) to dial.
Recognised command line options:
+C <config file>: to give alternative configuration file. Ignored, for future use.
+t <fax number>: destination fax number. This still shows a popup window! If you really want to use command line only, use the sendfax tool directly. Can appear multiple times for multiple recipients.
+tf <filename>: reads fax numbers from plain text file. The fax numbers have to be seperated by <CR> (a return, so each on a new line), a comma, a <tab>, or just by a space. The fax numbers are expected in international format when starting wiht a + sign, and will be dialed as given otherwise. Make sure there are no spaces or so in the fax numbers, as that is seen as seperation for a next number!!
To view sent/received faxes or send one manually, run 'SquirrelFax' and you can do this. This popup function is mainly for use with OpenOffice.org and other applications producing pdf or ps files.
4 Dependencies
Of course this software makes heavy use of other programs. Required are, besides an installation of the Python environment:
- for the user interface:
- Gnome
- libglade
- for sending/receiving faxes:
- mgetty+sendfax or hylafax
- for viewing and managing faxes:
- Ghostscript
- gv
- the pbm utilities (pbm-progs)
If you know the rootpassword, and want to use the privileged options: make sure you are in the sudoers file!!
- become root
- go to /etc
- edit sudoers file; add the following line:
<username> ALL = ALL
This line allows user with <username> to run all commands on all hosts as any user.
5 Author and copyrights
Written and copyright by Wouter van Marle, 2003. This program may be copied under the GNU General Public Licence. See the included file COPYING.
6 Disclaimer
Use this software fully at your own risk. This software comes with no guarentee at all. If it breaks anything: you have been warned.