faxrm - Man Page

faxrm [ -a ] [ -d ] [ -p pass[:adminpass] ] [ -u user ] [ -O config ] [ -v ] [ -h hostname ] id...

faxrm removes one or more jobs or documents from a HylaFAX server. If a job that is to be removed is being processed by a server, it is first aborted.

An id is either a number that identifies a job (default) or, if the -d option is specified, a document pathname. Job identifiers are printed by sendfax(1) when jobs are queued for transmission; they can also be displayed with faxstat(1). The names of documents associated with outbound jobs can be seen by supplying the -f option to faxstat. Documents in the receive queue can be viewed with the -r option to faxstat.

Unprivileged users can only remove jobs or documents that they own. Clients with administrative privileges can remove any job or document (see the -a option below).  The user name may be specified by the FAXUSER environment variable.

-a

Use administrative privileges; faxrm will prompt for the password to set administrative privileges.

-d

Interpret each id as a document pathname. If a pathname does not begin with “/” then faxrm automatically prepends “/docq/”.

-h host

Contact the server at the specified host. The host may be either a symbolic name or a network address. IPv6 addresses are given in “[xx:xx::x]:port” format. If no server is specified then If no -h option is supplied, faxrm uses the FAXSERVER environment variable to identify the HylaFAX server to contact. If this variable is not set, then faxrm checks for a setting in the configuration files (first in the per-user file and then in the system-wide file). If all of the above fails, then faxrm attempts to contact a server on the machine where it is run.

-O config

Treat config as a configuration parameter specification that is interpreted after reading the configuration file. For example, “-O Host:fax.example.com” would set the Host configuration parameter to “fax.example.com”, overriding any setting in the configuration file.

-p pass:adminpass

The login password and optionally the associated admin password (separated by a colon). If no password is given then the user will be prompted if one is required.  If -a is used and no adminpass is given, then the user will be prompted for it.

-u user

The login username to use in client-server communication protocol.  If no user is given then the user will be prompted if one is required.

-v

Trace the protocol messages to and from the server.

faxrm reads configuration information from the file /etc/hylafax/hyla.conf and then from the file ~/.hylarc. Configuration files follow the conventions described in hylafax-client(1). The following configuration parameters are recognized:

The configuration parameters are explained below:

Host

The host to contact for service. (Equivalent to the -h option.)

PassiveMode

Whether or not to use passive mode in communication with the server.

Port

The network port to contact for service. (Equivalent to the -h option.)

Protocol

The name of the communication protocol to use when contacting a server. (Equivalent to the FAXSERVICE environment variable.)

Timeout

The timeout, in seconds, to wait for a server response.

Verbose

Control protocol tracing. (Equivalent to the -v option.)

Job %s removed. A confirmation that the job was successfully removed from the sendq directory.

Job %s removed (from doneq). A confirmation that the job was successfully removed from the done directory; the directory where jobs are placed once they are finished.

%s removed. A confirmation that the document was successfully deleted from the server.

Additionally faxrm returns 0 when all jobs were successfully removed or 1 when one or more jobs couldn't be removed.

hylafax-client(1), sendfax(1), faxalter(1), faxstat(1), hfaxd(8C)

faxabort.8c(8), faxalter(1), faxq(1), faxq-helper(8), faxqueue(5), faxstat(1), hfaxd.8c(8), hylafax.8c(8), hylafax-client(1), jobcontrol.8c(8), mgetty_fax(1), sendfax(1), sendpage(1).