DFfaxrm

DFfaxrm — Remove faxes from the outgoing fax queue

Synopsis

DFfaxrm { [-] | [FaxId#...] | [-a] }

Description

DFfaxrm removes faxes from the outgoing fax queue, that is, those faxes that have been scheduled for sending but have not yet been sent.

A specific fax can be removed by supplying its faxid#, which can be obtained using DFfaxq.

Example 3.46. Removing a fax by its faxid

% DFfaxq
FaxId Owner Scheduled Time  File       Status Try To 
  307 usr1  Nov 30 16:18:23 /etc/fstab New    0   1234567
  308 usr1  Nov 30 16:18:23 /etc/fstab New    0   555-1212
% DFfaxrm 307


DFfaxrm reports the names of any faxes it removes, and is silent if there are no applicable faxes to remove.

When DFfaxrm removes a queue entry, faxes that are scheduled to be sent (status New) or retried (status Retry) in the future will not be sent or retried. However, any entries that have a status Sending are currently being transmitted and cannot be aborted. These faxes may be transmitted successfully, but any success command arguments specified to DFsendfax will not be executed. If a Sending status transmission fails, it will not be retried if it has been removed.

Options

Exactly one of the options is required. It is an error to mix these options. It is also an error to not supply any option.

-

remove all faxes owned by the user executing the command. Fax ownership is determined by the user's login name on the machine where the fax was originally queued for sending.

faxid#

remove the fax specified by faxid#. Multiple faxid#s can be specified.

-a

remove all faxes from the outgoing fax queue. This option can only be invoked by users datafax and root.

Exit Status

DFfaxrm exits with one of the following statuses:

0

The command was successful.

> 0

The required command-line arguments were not present or were incorrectly specified.

Examples

Example 3.47. Removing a fax by its faxid

% DFfaxq
FaxId Owner Scheduled Time  File       Status Try To 
  314 usr1  Dec 02 12:04:07 /etc/magic New    0   1234567
                                       New    0   9876543
% DFfaxrm 314
STATUS  FaxId Owner File       Status Try To 
DELETED   314 usr1  /etc/magic New    0   1234567
                               New    0   9876543

See Also

DFfaxq