faxrm.1
上传用户:weiyuanprp
上传日期:2020-05-20
资源大小:1169k
文件大小:6k
源码类别:

传真(Fax)编程

开发平台:

C/C++

  1. ." $Id: faxrm.1,v 1.9 2009/09/29 11:46:01 faxguy Exp $
  2. ."
  3. ." HylaFAX Facsimile Software
  4. ."
  5. ." Copyright (c) 1990-1996 Sam Leffler
  6. ." Copyright (c) 1991-1996 Silicon Graphics, Inc.
  7. ." HylaFAX is a trademark of Silicon Graphics
  8. ." 
  9. ." Permission to use, copy, modify, distribute, and sell this software and 
  10. ." its documentation for any purpose is hereby granted without fee, provided
  11. ." that (i) the above copyright notices and this permission notice appear in
  12. ." all copies of the software and related documentation, and (ii) the names of
  13. ." Sam Leffler and Silicon Graphics may not be used in any advertising or
  14. ." publicity relating to the software without the specific, prior written
  15. ." permission of Sam Leffler and Silicon Graphics.
  16. ." 
  17. ." THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  18. ." EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  19. ." WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  20. ." 
  21. ." IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  22. ." ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  23. ." OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  24. ." WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  25. ." LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  26. ." OF THIS SOFTWARE.
  27. ."
  28. .if n .po 0
  29. .ds Fx fIHylas-1FAXs+1fP
  30. .TH FAXRM 1 "May 12, 1996"
  31. .SH NAME
  32. faxrm - remove a *(Fx job or document from a server
  33. .SH SYNOPSIS
  34. .B faxrm
  35. [
  36. .B -a
  37. ] [
  38. .B -d
  39. ] [
  40. .B -p
  41. .I pass[:adminpass]
  42. ] [
  43. .B -u
  44. .I user
  45. ] [
  46. .B -O
  47. .I config
  48. ] [
  49. .B -v
  50. ] [
  51. .B -h
  52. .I hostname
  53. ]
  54. .IR id ...
  55. .SH DESCRIPTION
  56. .I faxrm
  57. removes one or more jobs or documents from a *(Fx server.
  58. If a job that is to be removed is being processed by a server,
  59. it is first aborted.
  60. .PP
  61. An 
  62. .I id
  63. is either a number that identifies a
  64. .I job
  65. (default) or, if the
  66. .B -d
  67. option is specified, a document pathname.
  68. Job identifiers are printed by
  69. .IR sendfax (1)
  70. when jobs are queued for transmission; they can also be displayed with
  71. .IR faxstat (1).
  72. The names of documents associated with outbound jobs
  73. can be seen by supplying the
  74. .B -f
  75. option to
  76. .IR faxstat .
  77. Documents in the receive queue can be viewed with the 
  78. .B -r
  79. option to
  80. .IR faxstat .
  81. .PP
  82. Unprivileged users can only remove jobs or documents that they own.
  83. Clients with administrative privileges can remove any job or document
  84. (see the
  85. .B -a
  86. option below).  The user name may be specified by the
  87. .B FAXUSER
  88. environment variable.
  89. .SH OPTIONS
  90. .TP 10
  91. .B -a
  92. Use administrative privileges;
  93. .I faxrm
  94. will prompt for the password to set administrative privileges.
  95. .TP 10
  96. .B -d
  97. Interpret each
  98. .I id
  99. as a document pathname.
  100. If a pathname does not begin with ``/'' then
  101. .I faxrm
  102. automatically prepends ``/docq/''.
  103. .TP 10
  104. .BI -h " host"
  105. Contact the server at the specified 
  106. .IR host .
  107. The
  108. .I host
  109. may be either a symbolic name or a network address.
  110. IPv6 addresses are given in ``[xx:xx::x]:port'' format.
  111. If no server is specified then
  112. If no
  113. .B -h
  114. option is supplied,
  115. .I faxrm
  116. uses the
  117. .SM FAXSERVER
  118. environment variable to identify the *(Fx server to contact.
  119. If this variable is not set, then
  120. .I faxrm
  121. checks for a setting in the configuration files (first in the
  122. per-user file and then in the system-wide file).
  123. If all of the above fails, then
  124. .I faxrm
  125. attempts to contact a server on the machine where it is run.
  126. .TP 10
  127. .BI -O " config"
  128. Treat
  129. .I config
  130. as a configuration parameter specification that is interpreted
  131. after reading the configuration file.
  132. For example, ``-O Host:fax.example.com'' would set the
  133. .B Host
  134. configuration parameter to ``fax.example.com'', overriding any setting in
  135. the configuration file.
  136. .TP 10
  137. .BI -p " pass:adminpass"
  138. The login password and optionally the associated admin password (separated by a colon).
  139. If no password is given then the user will be prompted if one is required.  If 
  140. .B -a
  141. is used and no adminpass is given, then the user will be prompted for it.
  142. .TP 10
  143. .BI -u " user"
  144. The login username to use in client-server communcation protocol.  If no user is given then
  145. the user will be prompted if one is required.
  146. .TP
  147. .B -v
  148. Trace the protocol messages to and from the server.
  149. .SH "CONFIGURATION PARAMETERS"
  150. .I faxrm
  151. reads configuration information from the file
  152. .B ${LIBDATA}/hyla.conf
  153. and then from the file
  154. .BR ~/.hylarc .
  155. Configuration files follow the conventions described in
  156. .IR hylafax-client (1).
  157. The following configuration parameters are recognized:
  158. .sp .5
  159. .nf
  160. .ta w'AutoConverPage    'u +w'boolean    'u +w's-1fIsee belowfPs+1    'u
  161. fBTag Type Default DescriptionfP
  162. Host string s-1localhosts+1 host to contact for service
  163. PassiveMode boolean s-1falses+1 whether or not to use passive mode
  164. Port integer s-14559s+1 port to use in contacting server
  165. Protocol string s-1tcps+1 protocol to use in contacting server
  166. Verbose boolean s-1Nos+1 whether or not to enable protocol tracing
  167. .fi
  168. .PP
  169. The configuration parameters are explained below:
  170. .TP 10
  171. .B Host
  172. The host to contact for service.
  173. (Equivalent to the
  174. .B -h
  175. option.)
  176. .TP 10
  177. .B PassiveMode
  178. Whether or not to use passive mode in communication with the server.
  179. .TP 10
  180. .B Port
  181. The network port to contact for service.
  182. (Equivalent to the
  183. .B -h
  184. option.)
  185. .TP 10
  186. .B Protocol
  187. The name of the communication protocol to use when contacting a server.
  188. (Equivalent to the
  189. .B FAXSERVICE
  190. environment variable.)
  191. .TP 10
  192. .B Verbose
  193. Control protocol tracing.
  194. (Equivalent to the
  195. .B -v
  196. option.)
  197. .SH DIAGNOSTICS
  198. .B "Job %s removed." 
  199. A confirmation that the job was successfully removed from the 
  200. .B sendq
  201. directory.
  202. .PP
  203. .B "Job %s removed (from doneq)." 
  204. A confirmation that the job was successfully removed from the 
  205. .B done
  206. directory; the directory where jobs are placed once they are finished.
  207. .PP
  208. .B "%s removed." 
  209. A confirmation that the document was successfully deleted from the server.
  210. .PP
  211. Additionally
  212. .B faxrm
  213. returns 0 when all jobs were successfully removed or 1 when one or more jobs couldn't be removed.
  214. .SH "SEE ALSO"
  215. .IR hylafax-client (1),
  216. .IR sendfax (1),
  217. .IR faxalter (1),
  218. .IR faxstat (1),
  219. .IR hfaxd (${MANNUM1_8})