================================================================================
| readme.txt
|
| @(#)drt/rightfax/src/readme.txt $Date: 2008/04/15 03:34:16 $
================================================================================

                                RIGHTFAX UTILITIES

                            By David R. Tribble, 2008

These are Win32 command-line utilities for RightFax.  They provide some useful
functionality for querying and configuring RightFax server accounts.

These programs require the following files in order to execute:
    RFWin32.dll
    RFI32RPC.ndr

These files should be located in the RightFax installation directory (e.g.,
'C:\Program Files\RightFAX').  Be sure that this directory is included in your
'PATH' environment variable setting.  The can be done with a command like:
    set PATH=%PATH%;C:\Program Files\RightFAX
Or you can do this through the Windows GUI by selecting:
    My Computer> Properties> Advanced> Environment Variables

These programs are designed to work with RightFax version 5.2 or later (they
have been tested on versions 7.2, 8.5, 8.7, and 9.0).

Running these programs in a command window with no parameters causes them to
display a usage message.  Each program takes one or more parameters, including
at a minimum the name or IP address of the RightFax server (specified as the
'-s' parameter).  To execute these commands on the the RightFax server itself
(i.e., the RightFax server software is running on the local system), you can use
'localhost' for the server name.

The following is a brief description of each program.

rfaxping.exe
Tests the network connection to the RightFax server, querying the server for its
version information.  If this command executes successfully, then the network
connection to the RightFax server is working.

rfaxlist.exe
Lists the faxes for a user on a RightFax server.  The output listing is
formatted similar to a directory file listing, and can be sorted and filtered in
several ways.

rfaxusers.exe
Lists the users registered on a RightFax server.  The listing can be filtered to
display the users within a single group.

rfaxmark.exe
Marks or unmarks a user's faxes (viewed, approved, viewed, released/held, etc.).

rfaxdelegate.exe
Lists and manages the delegates assigned to RightFax accounts.  Delegates can be
listed, or added or deleted for a given account.

================================================================================