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

传真(Fax)编程

开发平台:

C/C++

  1. ." $Id: sendfax.1,v 1.18 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. .ds Ps Ps-2OSTs+2Ss-2CRIPTs+2
  31. .TH SENDFAX 1 "January 06, 2001"
  32. .SH NAME
  33. sendfax - submit a facsimile job for transmission
  34. .SH SYNOPSIS
  35. .B sendfax
  36. [
  37. .I options
  38. ] [
  39. .IR files ...
  40. ]
  41. .SH DESCRIPTION
  42. .I sendfax
  43. submits one or more facsimile transmission requests
  44. to a *(Fx facsimile server.
  45. .I sendfax
  46. may prompt the user for a password and admin password
  47. depending on the invocation and server configuration.
  48. Requests are normally processed immediately, although
  49. they may also be queued for transmission at a later time
  50. using a syntax identical to the
  51. .IR at (1)
  52. command.
  53. For each job that is queued,
  54. .I sendfax
  55. prints a
  56. .I "job identifier"
  57. and a
  58. .I "job group identifier"
  59. on the standard output.
  60. A job identifier is the token by which jobs are
  61. identified within *(Fx; job group identifiers are
  62. used to reference a set of jobs that have been
  63. submitted at the same time.
  64. Job and job group identifiers can be supplied to the
  65. .IR faxrm (1)
  66. command to remove the jobs or to the
  67. .IR faxalter (1)
  68. command to alter job parameters.
  69. .PP
  70. Facsimile are made from the concatenation
  71. of a cover page (see below)
  72. and one or more files specified on the command line.
  73. If no files are supplied on the command line,
  74. .I sendfax
  75. will read data from the standard input unless polling is requested.
  76. Cover pages are distinguished for the purpose of generating ``c
  77. .IR "continuation cover pages" ''
  78. on the server;
  79. these are makeup cover pages that are automatically generated if a
  80. job fails after sending the original user-specified cover page.
  81. .PP
  82. .I sendfax
  83. passes *(Ps(rg and
  84. .SM TIFF
  85. documents directly through to the fax server for transmission,
  86. and attempts to convert other file formats to either *(Ps or
  87. .SM TIFF.
  88. In normal operation
  89. .I sendfax
  90. automatically converts
  91. .SM ASCIIc
  92. -text,
  93. .IR troff (1)
  94. output,
  95. Portable Document Format (PDF), and
  96. Silicon Graphics format images for transmission.
  97. Support for other file formats can be easily added
  98. through an extensible file typing and conversion facility; see
  99. .IR typerules (${MANNUM4_5}).
  100. Note that since
  101. .SM TIFF
  102. Class F documents are processed directly it is simple to forward
  103. a received facsimile.
  104. .PP
  105. By default
  106. .I sendfax
  107. will generate a cover page for each facsimile that is to be transmitted.
  108. This cover page is created by the ancillary
  109. .IR faxcover (1)
  110. program using information deduced by
  111. .I sendfax
  112. and by information supplied on the command line.
  113. Automatic cover page generation may be suppressed with the
  114. .B -n
  115. option.
  116. .PP
  117. In addition to sending documents,
  118. .I sendfax
  119. can be used to poll a remote facsimile machine to retrieve
  120. waiting documents.
  121. If the
  122. .B -p
  123. option is specified, a polling request will be submitted
  124. to each destination.
  125. If a poll request is made in conjunction with the transmission
  126. of documents, the poll request will take place after the documents
  127. are transmitted.
  128. Documents retrieved by polling are returned to the requestor
  129. by electronic mail and may be viewed with a suitable viewer program.
  130. .PP
  131. One or more destinations must be specified on the command line
  132. using the
  133. .B -d
  134. option.
  135. A destination is the dialing string to use to contact
  136. the remote fax machine.
  137. Phone numbers may include non-alphanumeric characters for
  138. readability(emonly alphanumerics, ``+'' (for denoting a
  139. country code), and ``#'' (for denoting a subaddress)
  140. are significant in placing a call.
  141. Alphabetic characters are automatically mapped to their numeric
  142. key equivalents: ``abcABC'' to ``2'', ``defDEF'' to ``3'', etc.
  143. Dialing prefixes, such as ``1'' and ``011''
  144. (for long distance calling in the United States) need
  145. not be included if an unambiguous number is specified.
  146. Examples of unambiguous phone numbers are:
  147. .nf
  148. .sp .5
  149. .RS
  150. .ta w'+31.77.594.313      'u
  151. +31.77.594.131 fIto call the NetherlandsfP
  152. +14159657824 fIto call CaliforniafP
  153. 9657824 fIto make a local callfP
  154. 1-215-356-1666 fIto call Pennsylvania from within the USfP
  155. .RE
  156. .sp .5
  157. .fi
  158. Non-numeric strings, such as ``*70'' (to defeat
  159. call waiting), may be included in the destination phone number.
  160. Whether or not they are stripped from the string used to
  161. dial the destination fax machine is dependent on the dialstring
  162. rules configured for use on the server; c.f.
  163. .IR hylafax-config (${MANNUM4_5})
  164. and
  165. .IR dialrules (${MANNUM4_5}).
  166. .PP
  167. A destination may also be specified as
  168. .IR user@fax-number .
  169. In this case the
  170. .I user
  171. string will be passed to
  172. .I faxcover
  173. as the identity of the recipient.
  174. Note that multi-word names must be enclosed in quote marks;
  175. for example,
  176. ``Sam Leff&ler@+1.415.555.1212''.
  177. .PP
  178. The order of options on the command line is significant.
  179. Each fax to be transmitted is assigned the current value of
  180. parameters specified on the command line; e.g. whether or not to
  181. generate a cover page.
  182. This means that options that specify parameters for a particular
  183. destination must precede the dialstring specified with the
  184. .B -d
  185. option.
  186. For example,
  187. .IP
  188. sendfax -n -d 5551212 /etc/passwd
  189. .LP
  190. submits a fax to 5551212 that has no cover page while
  191. .IP
  192. sendfax -d 5551212 -n /etc/passwd
  193. .LP
  194. submits the same fax but with the default cover page handling.
  195. Note also that parameter values persist across 
  196. .B -d
  197. options so the following
  198. .IP
  199. sendfax -n -d 5551212 -d 5551313 /etc/network
  200. .LP
  201. submits two facsimile, both of which have no cover page.
  202. .SH OPTIONS
  203. .TP 12
  204. .B -1
  205. Transmit facsimile documents using 1-D MH compression.
  206. By default *(Fx will use the optimal compression scheme supported
  207. by the transmitting modem and receiving facsimile device.
  208. .TP 12
  209. .B -2
  210. Transmit facsimile documents using 2-D MR compression, if possible.
  211. By default *(Fx will use the optimal compression scheme supported
  212. by the transmitting modem and receiving facsimile device.
  213. .TP 12
  214. .B -3
  215. Transmit facsimile documents using 2-D MMR compression, if possible.
  216. By default *(Fx will use the optimal compression scheme supported
  217. by the transmitting modem and receiving facsimile device.
  218. .TP 12
  219. .BI -a " time"
  220. Schedule transmission up to one year in advance at the indicated
  221. .IR time .
  222. .I Time 
  223. is specified in the format:
  224. ``HH:MM [AM|PM] | now [+ N 
  225. .I period 
  226. .I month 
  227. DD | 
  228. .I dayofweek 
  229. ] [ @ 
  230. .I timeofday
  231. ]'' where 
  232. .I month 
  233. can be Jan(uary), Feb(ruary), Mar(ch), Apr(il), May, Jun(e), Jul(y), 
  234. Aug(ust), Sep(tember), Oct(ober), Nov(ember), or Dec(ember); 
  235. .I period 
  236. can be minute(s), hour(s), day(s), week(s), or month(s); 
  237. .I dayofweek 
  238. can be Mon(day), Tue(sday), Wed(nesday), Thu(rsday), Fri(day), 
  239. Sat(urday), Sun(day); 
  240. e.g. ``now + 30 minutes'' to schedule transmission
  241. 30 minutes in the future.  Trailing information in the 
  242. .I time 
  243. field (such as YYYY) is ignored. 
  244. By default,
  245. .I sendfax
  246. schedules facsimile for immediate delivery.  Time should be given 
  247. in the user's local time.
  248. Conversely, the
  249. .I timeofday
  250. field restricts the job from sending at various times
  251. relative to the server.  The syntax for
  252. .I timeofday
  253. is identical to the
  254. .B TimeOfDay
  255. syntax found in 
  256. .IR hylafax-config (${MANNUM4_5}).
  257. .TP
  258. .BI -A
  259. Archive the job on the server according to the
  260. bin/archive script when the job is done.
  261. .TP
  262. .BI -b " speed"
  263. Transmit facsimile documents using a signalling rate that is
  264. constrained to be at least
  265. .I speed
  266. bits/second.
  267. If the specified speed is greater than the transmitting modem
  268. or receiver is capable of, it is reduced to the highest possible
  269. speed both devices support.
  270. If a negotiated signalling rate greater than or equal to
  271. .I speed
  272. cannot be negotiated then the job is aborted.
  273. Possible speeds are: 2400, 4800, 7200, 9600, 12000, 14400, 16800,
  274. 19200, 21600, 24000, 26400, 28800, 31200, and 33600.
  275. By default *(Fx will use the fastest possible rate supported by
  276. the transmitting modem and receiving facsimile device.
  277. .TP
  278. .BI -B " speed"
  279. Try to transmit facsimile documents using the
  280. desired signalling rate.
  281. Possible speeds are: 2400, 4800, 7200, 9600, 12000, 14400, 16800,
  282. 19200, 21600, 24000, 26400, 28800, 31200, and 33600.
  283. If the specified speed is greater than the transmitting modem
  284. or receiver is capable of, it is reduced to the highest possible
  285. speed both devices support.
  286. By default *(Fx will use the fastest possible rate supported by
  287. the transmitting modem and receiving facsimile device (unless
  288. restricted by other server configuration); this
  289. option can be used to reduce the speed.
  290. Note that international calls are frequently more reliable when
  291. transmissions are restricted to 9600 bits/second.
  292. For Class 1/1.0 devices, if the specified speed is not greater
  293. than 14400 then V.34 will not be attempted, and if the specified
  294. speed is 9600 or 7200 then V.29 will be assumed in lieu of V.17.
  295. .TP 12
  296. .BI -c " comments"
  297. Pass
  298. .I comments
  299. to the
  300. .IR faxcover (1)
  301. program for inclusion in the comments field of any generated
  302. cover page.
  303. .TP 12
  304. .BI -C " file"
  305. Pass
  306. .I file
  307. to the
  308. .IR faxcover (1)
  309. program for use as the cover page template.
  310. .TP 12
  311. .B -D
  312. Enable notification by electronic mail when the
  313. facsimile has been delivered.
  314. By default *(Fx will notify the submitter only if there is
  315. a problem with a job.
  316. .TP 12
  317. .BI -d " destination"
  318. Create a job to transmit the supplied documents to
  319. a facsimile machine at the indicated
  320. .IR destination .
  321. If the
  322. .I destination
  323. is of the form ``fIuserfP@fIphone-numberfP#fIsubaddressfP'' then any
  324. cover page will show fIuserfP as the intended recipient, and the 
  325. remote system will be supplied the subaddress value (i.e. for routing) 
  326. provided that the sending modem and the receiving system support it.
  327. .TP 12
  328. .B -E
  329. Disable use of the Error Correction Mode (s-1ECMs+1)
  330. when transmitting page data. Setting s-1ECMs+1 to false
  331. will limit the maximum speed to 14400 bps.
  332. By default *(Fx will attempt to use s-1ECMs+1 when both
  333. the transmitting modem and receiving device support it.
  334. Note that international calls are sometimes faster when
  335. s-1ECMs+1 is disabled.
  336. Beware also that some modems and/or facsimile devices do not
  337. properly implement s-1ECMs+1 causing transmission failures.
  338. .TP 12
  339. .BI -e " name"
  340. Use
  341. .I name
  342. as the name value in the outbound call identification.
  343. .TP 12
  344. .BI -f " from"
  345. Use
  346. .I from
  347. as the identity of the facsimile sender.
  348. Otherwise the sender is the user that invoked
  349. .IR sendfax .
  350. The sender is an account name to which the *(Fx software
  351. should direct notification messages.
  352. The
  353. .I from
  354. identity may be a full-blown ``From:'' line, e.g.
  355. e.g. ``Joe Blow <joe@foo.com>''
  356. and ``joe@foo.com (Joe Blow)'' are acceptable.
  357. If no host-part is specified in the
  358. .I from
  359. string the local hostname is used.
  360. This option is useful when
  361. .I sendfax
  362. is invoked on behalf of another user, such as in the implementation
  363. of an electronic mail to fax gateway.
  364. .TP 12
  365. .BI -F " format"
  366. Use the specified
  367. .I format
  368. when imaging tag lines on outgoing pages.
  369. Consult the description of the
  370. .B TagLineFormat
  371. parameter in
  372. .IR hylafax-config (${MANNUM4_5})
  373. for an explanation of how to construct a format string.
  374. .IP
  375. fINote that many locales require that proper identification
  376. appear on all transmitted facsimile; when using this facility
  377. one should always include proper identification (e.g. a phone
  378. number) in the imaged taglines.fP
  379. .IR 
  380. .TP 12
  381. .B -G
  382. Enable usage of any extended resolutions supported by the receiver.
  383. .B -G
  384. supersedes the usage of any
  385. .B -l
  386. or
  387. .B -m
  388. options.  Beware that increased resolution will increase transmission time.
  389. .TP 12
  390. .BI -h " fR[fPmodemfR@]fPhostfR[fP:portfR]fP"
  391. Force the jobs to be processed on a specific
  392. .I host
  393. and, optionally, using a particular
  394. .IR modem .
  395. The
  396. .I host
  397. may be either a symbolic name or a network address.
  398. IPv6 addresses are given in ``[xx:xx::x]:port'' format.
  399. If no
  400. .B -h
  401. option is supplied,
  402. .I sendfax
  403. uses the
  404. .SM FAXSERVER
  405. environment variable to identify the *(Fx server to
  406. which the jobs should be directed.
  407. If no server is specified then
  408. .I sendfax
  409. attempts to contact a server on the local host.
  410. If no modem is specified, the job will be submitted to any
  411. available modem.
  412. .TP 12
  413. .BI -i " identifier"
  414. Use the 
  415. .I identifier
  416. string in any notification messages instead of the usual job
  417. identifier number.
  418. This option is useful for applications that cross reference
  419. notification messages against job submissions.
  420. .TP
  421. .BI -I " time"
  422. If a job must be requeued because of a communication failure schedule
  423. the retry according to the specified
  424. .IR time .
  425. Times are given in seconds.
  426. Minutes, hours, and days can be specified with
  427. ``fIminfP'', ``fIhourfP'', and ``fIdayfP'' suffixes, respectively.
  428. By default *(Fx reschedules jobs using retry times that depend on
  429. the manner in which the job failed; this interface permits a user to
  430. override this algorithm and specify a single fixed retry time for all
  431. communication failures.
  432. .TP 12
  433. .BI -k " time"
  434. Kill the job if it does not complete in the indicated
  435. .IR time .
  436. The
  437. .I time
  438. is specified using notation identical to the
  439. .B -a
  440. option.
  441. Note that the
  442. .I time
  443. is relative to the time of the initial time-to-send.
  444. The default kill time is ``now + 3 hours'' (three hours from the time
  445. the job is first processed).
  446. To retry for an hour, ``now +1 hour'' could be used.
  447. .TP 12
  448. .B -l
  449. Transmit the facsimile at a vertical resolution of
  450. 98 lines/inch; otherwise known as fIlow resolutionfP.
  451. .TP 12
  452. .B -m
  453. Transmit the facsimile at a vertical resolution of
  454. 196 lines/inch; otherwise known as fImedium resolutionfP
  455. or fIfine modefP.
  456. .TP
  457. .BI -M " mst"
  458. Transmit facsimile documents using the specified
  459. minimum scanline time.
  460. Possible times are: 0ms, 5ms, 10ms2, 10ms, 20ms2, 20ms, 40ms2, and 40ms.
  461. If the specified time is less than the transmitting modem
  462. or receiver is capable of, it is increased to the lowest possible
  463. time both devices support.
  464. By default *(Fx will use the lowest possible time supported by
  465. the transmitting modem and receiving facsimile device (unless
  466. restricted by other server configuration).
  467. This option is mostly useful for debugging.
  468. .TP 12
  469. .B -n
  470. Suppress the automatic generation of a cover page for
  471. subsequent facsimile.
  472. Note that polling requests do not receive a cover page unless they
  473. are combined with the transmission of one or more files.
  474. .TP
  475. .B -N
  476. Do not notify the sender by electronic mail when the
  477. facsimile has been delivered or requeued.
  478. .TP 12
  479. .BI -o " login"
  480. Specify the fax owner login name, replacing any
  481. .B FAXUSER
  482. environment variable that may be set for the same purpose.
  483. If neither is specified, the user's 
  484. current login name is used.  The login password may also
  485. be provided by separating it from the owner login name with
  486. a colon, like ``owner:pass''.
  487. .TP 12
  488. .BI -O " option:value"
  489. Submit
  490. .I option
  491. with the indicated
  492. .I value
  493. as a job parameter in the client-server protocol for the job.
  494. Multiple instances of this command-line option may be used.
  495. The following
  496. .I options
  497. are currently supported:
  498. .ne 1i
  499. .sp .5
  500. .ta w'fB131072 (0x20000)    fP'u +w'Modem Communications    'u
  501. .nf
  502. fBOption       Value Type        DescriptionfP
  503. ignoremodembusy boolean           whether or not to ignore modem busy status (requires server configuration to allow)
  504. nocountcover    integer           don't include this number of initial pages in the page counting
  505. serverdocover   boolean           whether or not the server should generate the cover-page, if configured
  506. skippages       integer           assume this number of pages in the first document have already been sent
  507. skippedpages    integer           assume this number of pages in unsubmitted documents were previously sent
  508. config          string            override configuration with this setting
  509. .sp .5
  510. .fi
  511. .TP 12
  512. .B -p
  513. Poll each destination for any available documents.
  514. If a poll request is made together with document transmission, the
  515. poll operation is done after the documents are transmitted.
  516. Documents received by polling are returned to the sender by
  517. electronic mail.
  518. .TP 12
  519. .BI -P " priority"
  520. Assign the specified scheduling
  521. .I priority
  522. to subsequent jobs.
  523. A priority is an integer value in the range [0-255].
  524. Lower values result in higher priority processing.
  525. By default, each job is assigned 127 for an initial scheduling priority.
  526. If a job's priority is greater than bulk faxes then the
  527. job's priority is raised (numerically lowered) for each
  528. failed attempt to transmit so that retransmit attempts
  529. are done ahead of newly submitted jobs.
  530. In the case of bulk faxes (numerically higher than 190), then the
  531. job's priority is lowered (numerically raised) for each failed
  532. attempt to transmit so that the whole of the bulk-queued jobs
  533. will be attempted before any are retried.
  534. The
  535. .I priority
  536. may also be specified as one of the following symbolic names:
  537. .I default
  538. or 
  539. .I normal
  540. (127),
  541. .I bulk
  542. or
  543. .I junk
  544. (191),
  545. .I low
  546. (190), or
  547. .I high
  548. (63).
  549. .TP 12
  550. .B -R
  551. Enable notification by electronic mail when the
  552. facsimile has been delivered and when it is requeued for retransmission.
  553. By default *(Fx will notify the submitter only if there is
  554. a problem with a job.
  555. .TP 12
  556. .BI -r " regarding"
  557. Pass 
  558. .I regarding
  559. to the
  560. .IR faxcover (1)
  561. program as the value of the ``Re:'' field of any generated cover page.
  562. .TP 12
  563. .BI -s " size"
  564. Set the page size to use for the transmitted facsimile.
  565. Facsimile are normally imaged with a system-default page size
  566. (usually letter-size pages, 8.5" by 11", for sites in North America).
  567. Alternate page sizes are specified symbolically using either
  568. the name or abbreviation of an entry in the
  569. .IR pagesizes (${MANNUM4_5})
  570. database; e.g.
  571. .I a3
  572. (ISO A3),
  573. .I a4
  574. (ISO A4),
  575. .I a5
  576. (ISO A5),
  577. .I a6
  578. (ISO A6),
  579. .I b4
  580. (ISO B4),
  581. .I na-let
  582. (North American Letter),
  583. .I us-leg
  584. (American Legal),
  585. .I us-led
  586. (American Ledger),
  587. .I us-exe
  588. (American Executive),
  589. .I jp-let
  590. (Japanese Letter),
  591. and
  592. .I jp-leg
  593. (Japanese Legal).
  594. Comparisons are case-insensitive and any match of a
  595. substring of the full page-size name is sufficient; e.g. ``legal'' would
  596. match ``American Legal''.
  597. .IP
  598. Note that it may not be permissible to image into the
  599. full page area; the guaranteed reproducible area for a page is 
  600. typically inset.
  601. Also, note that while arbitrary page sizes can be specified through
  602. the page size database,
  603. only a limited set of page dimensions are supported by the
  604. Group 3 facsimile protocol.
  605. Thus if an odd-size facsimile is submitted for transmission
  606. it may not be possible to determine if it can be sent
  607. until the fax server establishes communication
  608. with the remote facsimile machine.
  609. .TP 12
  610. .BI -S " tsi"
  611. Pass tsi to the server as the suggested sender identification to be
  612. used, for example, in tagline imaging and fax protocol.
  613. .TP 12
  614. .BI -t " tries"
  615. Make no more than
  616. .I tries
  617. attempts to send the facsimile.  (A try is a call in which carrier is 
  618. established and the facsimile protocol is commenced; this is contrasted 
  619. with a call attempt that might have failed because the line was busy.)  
  620. Without specifying a "tries" value to the server *(Fx will, with some 
  621. exceptions, make an unlimited 
  622. .I number 
  623. of attempts to completely send the facsimile before the 
  624. .I "kill time"
  625. expires.  (The exceptions are that *(Fx will terminate a job if 3 
  626. consecutive attempts to send a particular page fail, or if it appears 
  627. the receiver is not a facsimile machine.)  Use ``-1'' to indicate that no 
  628. .I tries 
  629. value should be specified to the server.
  630. .TP 12
  631. .BI -T " maxdials"
  632. Make no more than
  633. .I maxdials
  634. calls in attempting to send the facsimile.  By default, HylaFAX will 
  635. redial 12 times before killing a job.
  636. Use ``-1'' to indicate that no
  637. .I maxdials
  638. value should be specified to the server.
  639. .TP 12
  640. .BI -U " voice-no"
  641. Pass
  642. .I voice-no
  643. to the
  644. .IR faxcover (1)
  645. program as the sender's voice number.
  646. .TP 12
  647. .BI -u " number"
  648. Use
  649. .I number
  650. as the number value in the outbound call identification and in tagline generation.
  651. .TP 12
  652. .BI -V " voice-no"
  653. Pass
  654. .I voice-no
  655. to the
  656. .IR faxcover (1)
  657. program as the destination person's voice number.
  658. .TP 12
  659. .BI -w
  660. Wait for the job to complete before ending the sendfax session.
  661. If this option is used, the sendfax process will not terminate until
  662. the job is completed.
  663. .TP 12
  664. .BI -W " fax-no"
  665. Pass
  666. .I fax-no
  667. to the
  668. .IR faxcover (1)
  669. program as the sender's fax number.
  670. .TP 12
  671. .BI -x " company"
  672. Pass
  673. .I company
  674. to the
  675. .IR faxcover (1)
  676. program as the destination company name.
  677. .TP 12
  678. .BI -X " company"
  679. Pass
  680. .I company
  681. to the
  682. .IR faxcover (1)
  683. program as the sender's company name.
  684. .TP 12
  685. .BI -y " location"
  686. Pass
  687. .I location
  688. to the
  689. .IR faxcover (1)
  690. program as the destination company's location.
  691. .TP 12
  692. .BI -Y " location"
  693. Pass
  694. .I location
  695. to the
  696. .IR faxcover (1)
  697. program as the sender's company location.
  698. .TP 12
  699. .BI -z " filename"
  700. Read destinations from
  701. .I filename
  702. which contains a list of the destinations formatted identically as 
  703. destinations for the
  704. .B -d
  705. option, one per line.  Usage of this option is similar to the
  706. .B -d
  707. option and may be done in conjunction with other
  708. .B -d
  709. and
  710. .B -z
  711. options.
  712. .TP 12
  713. .B -v
  714. Print information on the standard output
  715. about each conversion and cover sheet
  716. generation operation it does.
  717. If 
  718. .B -v
  719. is specified twice, the protocol between
  720. .I sendfax
  721. and the
  722. .I hfaxd
  723. server process that does the submission work on the
  724. remote machine is also displayed.
  725. .SH "CONFIGURATION PARAMETERS"
  726. .I sendfax
  727. reads configuration information from the files
  728. .BR ${LIBDATA}/hfaxd.conf ,
  729. .BR ${LIBDATA}/hyla.conf ,
  730. .BR ${LIBDATA}/sendfax.conf ,
  731. and
  732. .BR ~/.hylarc ;
  733. in that order, with later-read settings superseding any 
  734. that may have been previously read.
  735. Configuration files follow the conventions described in
  736. .IR hylafax-client (1).
  737. The following configuration parameters are recognized.
  738. Parameters marked with 鹿 are not available in ${LIBDATA}/hfaxd.conf :
  739. .sp .5
  740. .nf
  741. .ta w'AutoCoverPage    'u +w'boolean    'u +w's-1fIsee belowfPs+1    'u
  742. fBTag Type Default DescriptionfP
  743. AutoCoverPage boolean s-1Yess+1 automatically generate cover page
  744. ChopThreshold float s-13.0s+1 page chopping threshold
  745. CoverCmd string s-1fIsee belowfPs+1 pathname of cover sheet program
  746. Cover-Comments string - cover page comments string
  747. Cover-Company鹿 string - cover page to-company name string
  748. Cover-Location鹿 string - cover page to-company location string
  749. Cover-Regarding string - cover page regarding string
  750. Cover-Template string - cover page template filename
  751. Cover-Voice鹿 string - cover page to-voice number string
  752. Cover-From-Company鹿 string - cover page from-company string
  753. Cover-From-Location鹿 string - cover page from-location string
  754. Cover-From-Voice鹿 string - cover page from-voice number string
  755. Cover-From-Fax鹿 string - cover page from-fax number string
  756. DateFormat string - cover page date format string
  757. DesiredEC integer s-12s+1 desired type of s-1ECMs+1
  758. DesiredMST string - desired minimum scanline time to use
  759. DesiredSpeed integer - desired signalling rate to use
  760. DialRules string s-1fIsee belowfPs+1 file containing dialstring rules
  761. From string - sender's identity
  762. HRes float s-1204.s+1 horizontal resolution
  763. Host string s-1localhosts+1 host to contact for service
  764. KillTime string - time to expire job
  765. MailAddr string - mail address for notification messages
  766. MaxDials integer s-112s+1 times to retry dialing
  767. MaxTries integer s-13s+1 times to retry transmission
  768. MinSpeed integer - minimum acceptable signalling rate
  769. Modem string - modem to use on server
  770. Notify string s-1nones+1 control email notification
  771. PageChop string s-1defaults+1 control page chop handling
  772. PageLength float - page length in millimeters
  773. PageSize string s-1defaults+1 page size by name
  774. PageWidth float - page width in millimeters
  775. PassiveMode boolean s-1falses+1 whether or not to use passive mode
  776. Port integer s-14559s+1 port to use in contacting server
  777. Priority string s-1defaults+1 job scheduling priority
  778. Protocol string s-1tcps+1 protocol to use in contacting server
  779. RetryTime string - delay between failed attempts to send
  780. SendTime string - time to send job
  781. TagLine string - tagline format string
  782. TypeRules string s-1fIsee belowfPs+1 file containing file typing rules
  783. VRes float s-198.s+1 vertical resolution
  784. Verbose boolean s-1Nos+1 whether or not to enable protocol tracing
  785. .fi
  786. .PP
  787. The configuration parameters are explained below.
  788. Certain configuration parameters, notably those for setting strings
  789. on automatically generated cover pages, are defined mainly for use
  790. by other *(Fx programs that share common code used by
  791. .IR sendfax .
  792. .TP 16
  793. .B AutoCoverPage
  794. Control whether or not a cover page is automatically generated
  795. for each job.
  796. (Equivalent to the
  797. .B -n
  798. option.)
  799. .TP 16
  800. .B ChopThreshold
  801. The amount of white space, in inches, that must be present at the bottom
  802. of a page before *(Fx will attempt to truncate the page transmission.
  803. .TP 16
  804. .B CoverCmd
  805. The absolute pathname of the program to use to generate cover pages.
  806. The default cover sheet program is 
  807. .BR ${BIN}/faxcover .
  808. .TP 16
  809. .B Cover-Comments
  810. The comments string to pass to the cover sheet program when
  811. auto-generating cover pages.
  812. .TP 16
  813. .B Cover-Company
  814. The to-company name string to pass to the cover sheet program when
  815. auto-generating cover pages.
  816. .TP 16
  817. .B Cover-Location
  818. The to-company location string to pass to the cover sheet program when
  819. auto-generating cover pages.
  820. .TP 16
  821. .B Cover-Regarding
  822. The regarding string to pass to the cover sheet program when
  823. auto-generating cover pages.
  824. .TP 16
  825. .B Cover-Template
  826. The absolute pathname of a cover sheet template file to use
  827. in auto-generating cover pages.
  828. .TP 16
  829. .B Cover-Voice
  830. The to-voice number string to pass to the cover sheet program when
  831. auto-generating cover pages.
  832. .TP 16
  833. .B Cover-From-Company
  834. The from-company name string to pass to the cover sheet program
  835. when auto-generating cover pages.
  836. .TP 16
  837. .B Cover-From-Location
  838. The from-location string to pass to the cover sheet program when
  839. auto-generating cover pages.
  840. .TP 16
  841. .B Cover-From-Voice
  842. The from-voice number string to pass to the cover sheet program when
  843. auto-generating cover pages.
  844. .TP 16
  845. .B Cover-From-Fax
  846. The from-fax number string to pass to the cover sheet program when
  847. auto-generating cover pages.
  848. .TP 16
  849. .B DateFormat
  850. The 
  851. .IR strftime (3)
  852. format string to pass to the cover page command when auto-generating
  853. cover pages.
  854. .TP 16
  855. .B DesiredEC
  856. Which type of the optional Error Correct Mode (s-1ECMs+1) to use when
  857. transmitting facsimile.  0 to disable, 1 for 64-byte ECM, and 2 for
  858. 256-byte ECM (default).
  859. .TP 16
  860. .B DesiredMST
  861. The desired minimum scanline time to use when transmitting facsimile.
  862. (Equivalent to the
  863. .B -M
  864. option.)
  865. .TP 16
  866. .B DesiredSpeed
  867. The desired signalling rate to the use when transmitting facsimile.
  868. (Equivalent to the
  869. .B -B
  870. option.)
  871. .TP 16
  872. .B DialRules
  873. The name of the file containing the dialstring processing rules to
  874. when preparing an externally visible representation of the dialstring
  875. (e.g. to strip credit card numbers).
  876. By default this is ${LIBDATA}/dialrules.
  877. .TP 16
  878. .B From
  879. The sender's identity.
  880. (Equivalent to the
  881. .B -f
  882. option.)
  883. .TP 16
  884. .B Host
  885. The host to contact for service.
  886. (Equivalent to the
  887. .B -h
  888. option.)
  889. .TP 16
  890. .B HRes
  891. The horizontal resolution to use when transmitting facsimile.
  892. (NB: fIthis currently has no effectfP.)
  893. .TP 16
  894. .B KillTime
  895. The expiration time to assign to each job.
  896. (Equivalent to the
  897. .B -k
  898. option.)
  899. .TP 16
  900. .B MailAddr
  901. The electronic mail address to direct notification messages from the
  902. server.
  903. If this string is specified without an ``@hostname'' part then the
  904. local hostname will automatically be appended.
  905. (Equivalent to the
  906. .B -f
  907. option.)
  908. .TP 16
  909. .B MaxDials
  910. The maximum number of times to dial the phone for each job.
  911. (Equivalent to the
  912. .B -T
  913. option.)
  914. .TP 16
  915. .B MaxTries
  916. The maximum number of times to retry sending a job.
  917. (Equivalent to the
  918. .B -t
  919. option.)
  920. .TP 16
  921. .B MinSpeed
  922. The minimum acceptable signalling rate to use when transmitting facsimile.
  923. (Equivalent to the
  924. .B -b
  925. option.)
  926. .TP 16
  927. .B Modem
  928. The modem to use on the server.
  929. (Equivalent to the
  930. .B -h
  931. option.)
  932. .TP 16
  933. .B Notify
  934. Control the email notification messages from the server.
  935. This string may be one of ``done'', ``none'', ``requeued'' or ``default''
  936. with an optionally preceding ``when '' (e.g. ``when done'').
  937. Note that ``when requeued'' implies ``when done''.
  938. (Equivalent to the
  939. .BR -D ,
  940. .BR -R ,
  941. and
  942. .B -N
  943. options.)
  944. .TP 16
  945. .B PageChop
  946. Control page chop handling when transmitting facsimile.
  947. This string may be one of ``none'', ``all'', or ``last' to have
  948. no pages chopped, all pages chopped, or only the last page chopped;
  949. respectively.
  950. Page chopping is controlled by the 
  951. .B ChopThreshold
  952. parameter.
  953. .TP 16
  954. .B PageLength
  955. Set the transmitted page length in millimeters.
  956. .TP 16
  957. .B PageSize
  958. Set the page dimensions according to an entry in the
  959. .IR pagesizes (${MANNUM4_5})
  960. database.
  961. (Equivalent to the
  962. .B -s
  963. option.)
  964. .TP 16
  965. .B PageWidth
  966. Set the transmitted page width in millimeters.
  967. .TP 16
  968. .B PassiveMode
  969. Whether or not to use passive mode in communication with the server.
  970. .TP 16
  971. .B Port
  972. The network port to contact for service.
  973. (Equivalent to the
  974. .B -h
  975. option.)
  976. .TP 16
  977. .B Priority
  978. The scheduling priority to assign to each job.
  979. (Equivalent to the
  980. .B -P
  981. option.)
  982. .TP 16
  983. .B Protocol
  984. The name of the communication protocol to use when contacting a server.
  985. (Equivalent to the
  986. .B FAXSERVICE
  987. environment variable.)
  988. .TP 16
  989. .B RetryTime
  990. The time to delay between job retries due to a communication failure.
  991. (Equivalent to the
  992. .B -I
  993. option.)
  994. .TP 16
  995. .B SendTime
  996. The time to send jobs.
  997. (Equivalent to the
  998. .B -a
  999. option.)
  1000. .TP 16
  1001. .B TagLine
  1002. The tagline format string to use when transmitting facsimile.
  1003. (Equivalent to the
  1004. .B -F
  1005. option.)
  1006. .TP 16
  1007. .B TypeRules
  1008. The name of the file containing file type conversion rules.
  1009. By default this is ${LIBDATA}/typerules.
  1010. .TP 16
  1011. .B Verbose
  1012. Control protocol tracing.
  1013. (Equivalent to the
  1014. .B -vv
  1015. option.)
  1016. .TP 16
  1017. .B VRes
  1018. Set the vertical resolution in lines/inch
  1019. to use when transmitting facsimile.
  1020. (Equivalent to the
  1021. .B -m
  1022. and
  1023. .B -l
  1024. options.)
  1025. .SH DIAGNOSTICS
  1026. The following messages are generated because of problems
  1027. encountered on the local machine.
  1028. .PP
  1029. .B "Could not call server."
  1030. The facsimile server on the remote machine did not respond.
  1031. .PP
  1032. .B "No input data; transmission aborted."
  1033. No data was supplied (typically on the standard input).
  1034. No facsimile will be sent.
  1035. .PP
  1036. .B "Error converting data; command was "%s."
  1037. A data conversion operation failed; the shell
  1038. command that was used is printed.
  1039. .PP
  1040. .B "Can not convert %s."
  1041. Data needed to be converted for transmission, but the
  1042. required conversion rule was not located.
  1043. This may indicate that the *(Fx
  1044. software was incorrectly installed; or perhaps
  1045. that an
  1046. .SM NFSc
  1047. -mounted directory is temporarily unavailable.
  1048. .PP
  1049. .B "%s: Can not determine file type."
  1050. .I sendfax
  1051. was unable to deduce the type of the file.
  1052. .PP
  1053. .B "%s: Not a regular file."
  1054. The file is something other than a regular file; for
  1055. example, a directory.
  1056. .PP
  1057. The following messages may be printed by
  1058. .IR sendfax .
  1059. These messages describe problems encountered by
  1060. the server process on the remote machine.
  1061. This list is incomplete;
  1062. other messages may be generated by the server under
  1063. unusual circumstances.
  1064. .SH FILES
  1065. .ta w'${LIBDATA}/sendfax.conf    'u
  1066. .nf
  1067. ~/.hylarc per-user configuration file
  1068. ${LIBDATA}/hyla.conf system-wide configuration file
  1069. ${LIBDATA}/sendfax.conf system-wide configuration file
  1070. ${LIBDATA}/typerules file type and conversion rules
  1071. ${LIBDATA}/pagesizes page size database
  1072. ${LIBDATA}/dialrules optional client dialstring rules
  1073. ${BIN}/faxcover for generating cover sheets
  1074. ${LIBEXEC}/textfmt for converting text to PostScript
  1075. ${LIBEXEC}/sgi2fax for converting SGI RGB images
  1076. ${SPOOL}/tmp/sndfaxXXXXXX temporary files
  1077. .fi
  1078. .SH "SEE ALSO"
  1079. .IR at (1),
  1080. .IR hylafax-client (1),
  1081. .IR faxalter (1),
  1082. .IR faxcover (1),
  1083. .IR faxmail (1),
  1084. .IR faxrm (1),
  1085. .IR faxstat (1),
  1086. .IR sgi2fax (1),
  1087. .IR textfmt (1),
  1088. .IR hfaxd (${MANNUM1_8}),
  1089. .IR hylafax-server (${MANNUM4_5}),
  1090. .IR typerules (${MANNUM4_5})