1FAXRM(1)                    General Commands Manual                   FAXRM(1)
2
3
4

NAME

6       faxrm - remove a HylaFAX job or document from a server
7

SYNOPSIS

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

DESCRIPTION

13       faxrm removes one or more jobs or documents from a HylaFAX server.   If
14       a job that is to be removed is being processed by a server, it is first
15       aborted.
16
17       An id is either a number that identifies a job (default) or, if the  -d
18       option  is specified, a document pathname.  Job identifiers are printed
19       by sendfax(1) when jobs are queued for transmission; they can  also  be
20       displayed with faxstat(1).  The names of documents associated with out‐
21       bound jobs can be seen by supplying the -f option  to  faxstat.   Docu‐
22       ments in the receive queue can be viewed with the -r option to faxstat.
23
24       Unprivileged  users  can  only  remove jobs or documents that they own.
25       Clients with administrative privileges can remove any job  or  document
26       (see  the  -a  option  below).   The  user name may be specified by the
27       FAXUSER environment variable.
28

OPTIONS

30       -a        Use administrative privileges;  faxrm  will  prompt  for  the
31                 password to set administrative privileges.
32
33       -d        Interpret each id as a document pathname.  If a pathname does
34                 not  begin  with  ``/''  then  faxrm  automatically  prepends
35                 ``/docq/''.
36
37       -h host   Contact  the  server  at the specified host.  The host may be
38                 either a symbolic name or a network address.  IPv6  addresses
39                 are  given  in  ``[xx:xx::x]:port''  format.  If no server is
40                 specified then If no -h option is supplied,  faxrm  uses  the
41                 FAXSERVER environment variable to identify the HylaFAX server
42                 to contact.  If this variable is not set, then  faxrm  checks
43                 for  a  setting in the configuration files (first in the per-
44                 user file and then in the system-wide file).  If all  of  the
45                 above  fails,  then faxrm attempts to contact a server on the
46                 machine where it is run.
47
48       -O config Treat config as a configuration parameter specification  that
49                 is  interpreted  after  reading  the configuration file.  For
50                 example, ``-O Host:fax.example.com'' would set the Host  con‐
51                 figuration  parameter  to ``fax.example.com'', overriding any
52                 setting in the configuration file.
53
54       -p pass:adminpass
55                 The login password and optionally the associated admin  pass‐
56                 word  (separated  by  a colon).  If no password is given then
57                 the user will be prompted if one is required.  If -a is  used
58                 and no adminpass is given, then the user will be prompted for
59                 it.
60
61       -u user   The login username to use in client-server communcation  pro‐
62                 tocol.  If no user is given then the user will be prompted if
63                 one is required.
64
65       -v        Trace the protocol messages to and from the server.
66

CONFIGURATION PARAMETERS

68       faxrm    reads    configuration    information    from     the     file
69       /etc/hylafax/hyla.conf and then from the file ~/.hylarc.  Configuration
70       files follow the conventions described in hylafax-client(1).  The  fol‐
71       lowing configuration parameters are recognized:
72       Tag               Type       Default      Description
73       Host              string     localhost    host to contact for service
74       PassiveMode       boolean    false        whether or not to use passive mode
75       Port              integer    4559         port to use in contacting server
76       Protocol          string     tcp          protocol to use in contacting server
77       Verbose           boolean    No           whether or not to enable protocol tracing
78
79       The configuration parameters are explained below:
80
81       Host      The  host  to  contact  for  service.   (Equivalent to the -h
82                 option.)
83
84       PassiveMode
85                 Whether or not to use passive mode in communication with  the
86                 server.
87
88       Port      The  network port to contact for service.  (Equivalent to the
89                 -h option.)
90
91       Protocol  The name of the communication protocol to use when contacting
92                 a  server.   (Equivalent  to the FAXSERVICE environment vari‐
93                 able.)
94
95       Verbose   Control protocol tracing.  (Equivalent to the -v option.)
96

DIAGNOSTICS

98       Job %s removed.  A confirmation that the job was  successfully  removed
99       from the sendq directory.
100
101       Job  %s removed (from doneq).  A confirmation that the job was success‐
102       fully removed from the done directory; the  directory  where  jobs  are
103       placed once they are finished.
104
105       %s  removed.  A confirmation that the document was successfully deleted
106       from the server.
107
108       Additionally faxrm returns 0 when all jobs were successfully removed or
109       1 when one or more jobs couldn't be removed.
110

SEE ALSO

112       hylafax-client(1), sendfax(1), faxalter(1), faxstat(1), hfaxd(8C)
113
114
115
116                                 May 12, 1996                         FAXRM(1)
Impressum