readme

用于使用moden进行传真的源代码

the "Tel number" box.  This can be entered directly into the box, or
by using the built-in addressbook.  The addressbook can be invoked by
pressing the "Tel number" button, or from the `File/Address book'
pull-down menu item.  See "Using the address book" further below.
However, if a telephone connection has already been established with
the remote fax receiver, then the fax can be sent without dialing by
leaving the "Tel number" box blank (a dialog will come up asking if
you would like to send the fax without dialing - this does the same
thing as 'fax send -m ...' using the efax 'fax' script from the
command line).

When a fax is received from the print system via the socket server,
the program settings can also be configured to bring up a dialog
automatically.  If the program is inactive (for example, it is not
standing by to receive faxes) the fax can be sent directly from this
dialog without the need to invoke the list of queued faxes received
from the socket.

Successfully sent faxes are copied to a directory in the $HOME/faxsent
directory, which has a name derived from the year, month, day, hour
and seconds when the sending of the fax was completed, and will appear
in the faxes sent list.  They are only included in that list if they
have been sent without error.  The efax message display box will
report on the progress of a fax being sent.  The fax list can be
brought up from the `File/List sent faxes' pull down menu item.  See
'Using the fax lists" further below.

Receiving faxes
---------------

Three ways of receiving faxes are provided for.

First, the program can be set to answer a fax call which is ringing
but has not been answered, by pressing the "Answer call" button.

Secondly, the program can take over a call which has already been
answered (say, by a telephone hand set) by pressing the "Take over
call" button.

Thirdly, the program can be placed in standby mode by pressing the
"Standby" button.  This will automatically answer any call after the
number of rings specified in the efax-gtkrc file, and receive the fax.
The program will keep on receiving faxes until the "Stop" button is
pressed.

Received faxes in tiffg3 format (one file for each page) are placed in
a directory in the $HOME/faxin directory, which has a name derived
from the year, month, day, hour and seconds when the relevant "Answer
call", "Take over call" or "Standy" button was pressed.  (Where in
standby mode after a fax has been received, any further fax will
derive its name from the time when receipt of the last received fax
has been completed and the program goes back into standby mode.)

Received faxes can be printed, viewed, described and managed using the
built in fax list facility.  This can be brought up from the
`File/List received faxes' pull down menu item.  See "Using the fax
lists" further below.

When a fax is received, a pop-up dialog can also be set to appear (go
to the Settings dialog to do this).  In the settings dialog you can
also specify a program to be executed when a fax is received.  The
number of the fax is passed as the first (and only) argument to the
program, which enables the program to find the fax in $HOME/faxin.
The distribution contains two executable scripts, mail_fax and
print_fax, which can be used to e-mail a fax or print a fax to a user
automatically when it is received.  (These scripts are not installed
by 'make install' - if you want to use them, make them executable with
'chmod +x' and copy them to a directory which is in the system path,
such as /usr/local/bin, and then specify the script name in the
settings dialog).

Using the address book
----------------------

To pick a telephone number from the address book, highlight the
relevant address by pressing the left mouse button over it, and then
press the "OK" button.

Addresses can be added to the address book by pressing the add button,
and then completing the relevant dialog which will appear.  To delete
an address from the address book, highlight the relevant address and
press the delete (trashcan) button.  The addressbook can be sorted by
using the up and down arrow buttons on a highlighted address, or by
dragging and dropping using the mouse.

Addresses are stored in file `$HOME/.efax-gtk_addressbook'.

Using the fax lists
-------------------

To bring up the fax lists, go to the the `File' menu and pick the
`List received faxes' or `List sent faxes' menu item.  Highlight the
fax to printed or viewed by pressing the left mouse button.  The
programs to be used to print and view the fax are specifed in the
efax-gtkrc configuration file, or if none are specified, the program
will print using lpr (which will work for most Unix systems) and view
with gv.

To print faxes, a PRINT_SHRINK parameter can be specifed in efax-gtkrc
to enable the fax page to fit within the printer margins.  A parameter
of 98 will work with most printers.  This can be changed while the
program is running by bringing up the `Settings' dialog and entering
it into the `Print/Print Shrink' box.

A fax can be deleted from a fax list by pressing the delete (trashcan)
button.  This will place the deleted fax in the $HOME/faxin/oldfax
or $HOME/faxsent/oldfax directory.

NB: link()/unlink() are used to move a fax, so $HOME/faxin/oldfax must
be on the same file system as $HOME/faxin, and $HOME/faxsent/oldfax
must be on the same file system as $HOME/faxsent.  If they are not,
the fax will remain in $HOME/faxin or $HOME/faxsent.

A description can be added to a received fax when appearing in a fax
list (or subsequently amended) by pressing the relevant button -- this
will enable faxes to be more easily identified.

To refresh a fax list (say, to update with any faxes received or sent
since the fax list was brought up), press the refresh button.

Settings
--------

The program settings can be changed by manually editing the efax-gtk
configuration file comprising $HOME/.efax-gtkrc,
$sysconfdir/efax-gtkrc or /etc/efax-gtkrc.  The file is searched for
in that order, so $HOME/.efax-gtkrc takes precedence over the other
two.

The configuration file can also be set by using the Settings dialog
launched from the `File/Settings' pull down menu item.  The settings
entered using this dialog are always stored as $HOME/.efax-gtkrc.
Accordingly, if the Settings dialog has been used, and you want to
revert to the global settings, this can be done either by deleting the
$HOME/.efax-gtkrc file, or by pressing the `Reset' button in the
Settings dialog, which will reload the Settings dialog from the global
configuration file ($sysconfdir/efax-gtkrc or /etc/efax-gtkrc).

Help can be obtained when filling out the Settings dialog by holding
the mouse over the relevant help (?) button, which will bring up a
"Tips" display, or by pressing the button, which will bring up an
information display.

                       USING WITH A WORD PROCESSOR

Printing to file from the program itself
----------------------------------------

Probably the easiest way of using the program with a word processor is
to print to file from the print dialog of the word processor program
concerned, and choosing a file name in the $HOME/faxout directory
which can then be selected with the file selector dialog in efax-gtk.
All Unix/Linux word and document processing programs will print to
file in Postscript format, ready to be faxed by efax-gtk.  (At least,
if there is one which does not, I do not know of it).

Faxing via CUPS
---------------

Version 2.2.* provides a socket server, which CUPS can connect to.
When the socket server is running, fax files received from CUPS will
automatically be displayed in a "Queued faxes from socket" list
maintained by efax-gtk.  From this list, a fax can be selected for
sending by efax-gtk, so there is no need to print to file from the
word processor and then select the file with the file selection dialog
in efax-gtk.

When a fax is received in this way from the print system via the
socket, the program settings can also be configured to bring up a
dialog automatically.  If the program is inactive (for example, it is
not standing by to receive faxes) the fax can be sent directly from
this dialog without the need to invoke the list of queued faxes
received from the socket.

If you are using CUPS and you want to connect it directly to efax-gtk
as mentioned above, you can do so by bringing up the fax
administration page for CUPS in a web browser, installing a new
printer with a name of "fax" (or whatever other name you want), choose
the IPP protocol, pick a URI of "socket://[hostname]:[port]", and
choose the "Raw" CUPS printer driver.

The port number can be any port number less than 65536 and more than
1023 which is not used by any other service on your machine/network
(this can be checked out by using nmap, but it is best to avoid any
listed in /etc/services).  For example, as you will usually be
printing from a local computer, if you choose a port number of 9900
(would would be quite reasonable) the URI would be:

socket://localhost:9900

You should then start efax-gtk, go to the Socket tab in the settings
dialog, check the "Run socket server" box, and enter 9900 in the "Port
to which faxes to be sent" box.

To send a fax from the "Queued faxes from socket" dialog, highlight
the one to be sent, press the "Enter selected fax to send" button in
the dialog (the one with an icon representing a fax machine) which
will enter the fax in the "File to fax" box in efax-gtk, and then
choose a telephone number to send it to and press the "Send fax"
button in the ordinary way.

If efax-gtk isn't running when you attempt to send a file via CUPS to
efax-gtk don't worry.  CUPS will queue the fax until it detects that
the efax-gtk socket server is running, and then send it to efax-gtk.

Faxing via lpd/lprng
--------------------

The socket server can also be used in the same way with lpd/lprng.
The files efax-gtk-faxfilter and efax-gtk-socket-client are installed
in /var/spool/fax, when you run 'make install' (the installation
directory can be changed at the ./configure stage using the
./configure --spooldir=[dir] parameter).  You should add at the end of
/etc/printcap the following -

fax:\
	:sd=/var/spool/fax:\
	:mx#0:\
	:sh:\
	:lp=/dev/null:\
	:if=/var/spool/fax/efax-gtk-faxfilter:

This will cause a printer by the name of "fax" to be available, which
(if printed to) will send the file to the efax-gtk socket server.  If
you set efax-gtk to listen on a port other than port 9900, you will
need to amend the file /var/spool/fax/efax-gtk-faxfilter by hand to
specify the correct port number on which efax-gtk is listening.

Don't forget to restart the lpd printer daemon after amending
/etc/printcap.  (An equivalent addition to /etc/printcap can also be
made by using the printer configuration tool with your distribution,
choosing a printer name of "fax" (or whatever other name you want),
choosing a printer device of "/dev/null", a spool directory of
"/var/spool/fax" and an input filter of
"/var/spool/fax/efax-gtk-faxfilter".)

                                LOGGING

Errors and warnings from efax are displayed in red in the application
text window, and information messages and reports on the progress of
negotiations and on fax status are displayed in black in the window.
In addition, these messages are sent to stderr and stdout
respectively.  Accordingly, fax status can be logged by redirecting
stderr and stdout to a log file.

As an alternative, a log file can also be maintained by setting the
LOG_FILE parameter in the efax-gtkrc configuration file, or by
entering a log file name via the Settings dialog.  If no log file is
specified, no log file will be maintained.

                                SCANNERS

If you have a scanner and want to fax it's output, you may find that
it produces a separate postscript file for each page.  The easiest way
of dealing with this is to concatenate the postscript page files
produced by the scanner to a single fax file such as /tmp/faxfile.ps,
using 'cat' and appropriate command line wildcards.  You may want to
automate this with a script.

Alternatively, as mentioned above, more than one file can be specified
in the "File to fax" box when the program is running.

                          INTERNATIONALISATION

Version 2.0 and above of the program has been written to accommodate
i18n support.  If anyone wants to provide me with a *.po file with
translations into their language/locale, I will include it in the
distribution.

An efax-gtk.pot file and other relevant build tools are included in
the po directory in the source directory for the purpose.

                          CONTACTING THE AUTHOR

My e-mail address is [e-mail].

Updates can be obtained from http://efax-gtk.sourceforge.net/

Chris Vine.