Manpages

-a time

Schedule transmission at the indicated time. Times are specified using the syntax of the at(1) command; e.g. ’’now + 30 minutes’’ to schedule transmission 30 minutes in the future. By default, sendpage schedules pages for ’’now’’. (In SNPP parlance this option specifies the ’’hold time’’ for the page; and may result in the page being delivered to the paging terminal but not delivered to the user until the specified time.)

-D

Enable notification by electronic mail when the page has been delivered to the service provider. This option is meaningful only when communicating with a Hyla FAX server.

-f from

Use from as the identity of the message sender. Otherwise the sender is the user that invoked sendpage. The sender is an account name to which the Hyla FAX software should direct email notification messages. The from identity may be a fullblown ’’From:’’ line, e.g. e.g. ’’Joe Blow <joe [AT] foo.com>’’ and ’’joe [AT] foo.com (Joe Blow)’’ are acceptable. If no host-part is specified in the from string the local hostname is used. This option is useful when sendpage is invoked on behalf of another user, such as in the implementation of an electronic mail to pager gateway.

-I time

If a job must be requeued because of a communication failure schedule the retry according to the specified time. Times are given in seconds. Minutes, hours, and days can be specified with ’’min’’, ’’hour’’, and ’’day’’ suffixes, respectively. By default Hyla FAX reschedules jobs using retry times that depend on the manner in which the job failed; this interface permits a user to override this algorithm and specify a single fixed retry time for all communication failures. This option is meaningful only when communicating with a Hyla FAX server.

-l level

Specify a particular service level to use in delivering a page. A service level defines both a scheduling priority and the time that a client is willing to wait to find out if delivery is successful or not. Normal delivery is obtained with level 1 (default). The SNPP specification identifies level 0 as the highest priority service level with levels 1-7 lower priority and levels 8-11 vendor/server-specific. For Hyla FAX server machines the mapping between service level and scheduling priority is defined by the configuration of the SNPP server process; see the PriorityMap parameter in hfaxd(8)

-n

Send to a numeric-only paging device; i.e. do not send a text message in the paging request.

-N

Do not notify the sender by electronic mail when the page has been delivered to the service provider (default). This option is meaningful only when communicating with a Hyla FAX server.

-p PIN

The Pager Identification Number ( PIN ) for a terminal that is to receive the message. A message can be sent to multiple destinations by specifying multiple -p options.

-q

Mark pages to be queued on the server and do not wait for their delivery. By default sendpage conforms to the SNPP spec by synchronously waiting for each page to be delivered. This option instructs sendpage to submit one or pages and then terminate immediately without waiting for their completion. When pages are queued it is advisable to enable email notification with the -D or -R options. Job queueing is a non-standard function of the SNPP implementation in Hyla FAX and is not available when submitting pages to non-Hyla FAX servers.

-R

Enable notification by electronic mail when the message has been delivered and when it is requeued for retransmission. Hyla FAX will always notify the sender by electronic mail if there is problem delivering a page (irregardless of the email notification setting). This option is meaningful only when communicating with a Hyla FAX server.

-s subject

Set the ’’subject’’ for the specified pages according to subject. For Hyla FAX subject is used as the identifier string returned in any email notification messages (instead of the usual job identifier number). This option is useful for applications that cross reference notification messages against job submissions.

-t tries

Make no more than tries attempts to send the page. By default, Hyla FAX will terminate a job if: 3 consecutive attempts to send a particular message fail, or it appears the receiver is not a service provider. Otherwise Hyla FAX places no limit on the number of attempts to send a page, instead terminating a job if it is not completed within a fixed period of time specified by the service level. Note that a try is a phone call in which carrier is established and the IXO/TAP or UCP protocol is commenced; this is contrasted with a call attempt that might have failed because the line was busy. This option is meaningful only when communicating with a Hyla FAX server.

-T dials

Make no more than dials phone calls when attempting to send a page. By default, Hyla FAX will terminate a job if: 12 attempts to reach a service provider fail, or it appears the receiver is not a service provider. Otherwise Hyla FAX terminates a job if it is not completed within a fixed period of time specified by the service level. This option is meaningful only when communicating with a Hyla FAX server.

-v

Trace the protocol between sendpage and the SNPP server process that does the delivery work on the remote machine. This information is directed to the standard output.

HoldTime

string

-

hold time to assign to pages

Host

string

localhost

host to contact for service

MailAddr

string

-

mail address for notification messages

MaxDials

integer

12

times to retry dialing

MaxTries

integer

3

times to retry transmission

Notify

string

none

control email notification

Port

integer

444

port to use in contacting server

Protocol

string

tcp

protocol to use in contacting server

QueueSend

boolean

No

whether or not to queue pages

RetryTime

string

-

delay between failed attempts to send

ServiceLevel

integer

SNPP service level for pages

Verbose

boolean

No

whether or not to enable protocol tracing

HoldTime

The hold time to assign to pages. (Equivalent to the -a option.)

Host

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

MailAddr

The electronic mail address to direct notification messages from the server. If this string is specified without an ’’@hostname’’ part then the local hostname will automatically be appended. (Equivalent to the -f option.)

MaxDials

The maximum number of times to dial the phone for each job. (Equivalent to the -T option.)

MaxTries

The maximum number of times to retry sending a job. (Equivalent to the -t option.)

Notify

Control the email notification messages from the server. This string may be one of ’’done’’, ’’none’’, ’’requeued’’ or ’’default’’ with an optionally preceding ’’when ’’ (e.g. ’’when done’’). Note that ’’when requeued’’ implies ’’when done’’. (Equivalent to the -D, -R, and -N options.)

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 SNPPSERVICE environment variable.)

QueueSend

Control whether or not to wait for the pages to be delivered. (Equivalent to the -q option.)

RetryTime

The time to delay between job retries due to a communication failure. (Equivalent to the -I option.)

ServiceLevel

The SNPP service level to assign to each page. (Equivalent to the -l option.)

Verbose

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

SNPPSERVER

The identity of the SNPP server to contact for service. This value is specified as ’’[modem@]host[:port]’’ where host is either a host name or the Internet ’’.’’ (dot) address of the host; port is the TCP port number or service name to use (default is ’’snpp’’ or 444); and modem is an optional modem name or class on the server machine to use in processing the requests (this is meaningful only when the server is running Hyla FAX ).

SNPPSERVICE

The communication service specification for communicating with the SNPP server. This value is specified as ’’port[/protocol]’’; by default ’’444/tcp’’.