1SENDPAGE(1) General Commands Manual SENDPAGE(1)
2
6 sendpage - submit a pager job for transmission
7
9 sendpage [ -O config ] [ options ] [ message... ]
10
12 sendpage submits a pager transmission request to a server using the
13 Simple Network Paging Protocol (SNPP) described in RFC 1861. Pager
14 requests specified with sendpage are normally processed immediately,
15 although they may also be queued for transmission at a later time using
16 a syntax identical to the at(1) command. For each job that is queued,
17 sendpage prints a job identifier on the standard output. A job identi‐
18 fier is the token by which jobs are identified within HylaFAX. Job
19 identifiers can be supplied to the faxrm(1) command to remove the jobs
20 or to the faxalter(1) command to alter job parameters.
21 Pages may be sent to one or more destination paging terminals and,
23 optionally, include a text message (depending on the capability of the
24 receiving device). Each destination is identified by a Pager Identifi‐
25 cation Number (PIN) specified with the -p option; for example, sendpage
26 -p 12345 ``Help, the fax machine is on fire!''. A PIN is typically a
27 numeric string though it may also be an alpha-numeric alias depending
28 on the capabilities of the SNPP server.
29 Text messages can be specified on the command line or taken from stan‐
31 dard input. The -n option must be used if no text message is to be
32 supplied with the page request—as for a numeric-only pager. Text sup‐
33 plied to the paging system is sent exactly as submitted including any
34 newline, carriage return, or non-ASCII data. Message preparation
35 including filtering and formatting must be done prior to submitting the
36 data to sendpage. Note that text supplied on the command line does not
37 include a trailing newline character.
38 The order of options on the command line is significant. Each page to
40 be transmitted is assigned the current value of parameters specified on
41 the command line; e.g. whether or not to queue the request. This means
42 that options that specify parameters for a particular destination must
43 precede the pager ID specified with the -p option. For example,
44 sendpage -l 2 -p sam Your network is hosed
46 submits a page to ``sam'' that has service level 2 while
48 sendpage -p sam -l 2 Your network is hosed
50 submits the same page but with the default service level (1). Note
52 also that parameter values persist across -p options so the following
53 sendpage -l 0 -p sam -p 5551212 Your network is hosed
55 submits two pages, both of which have service level 0.
57
59 -a time Schedule transmission at the indicated time. Times are
60 specified using the syntax of the at(1) command; e.g. ``now
61 + 30 minutes'' to schedule transmission 30 minutes in the
62 future. By default, sendpage schedules pages for ``now''.
63 (In SNPP parlance this option specifies the ``hold time''
64 for the page; and may result in the page being delivered to
65 the paging terminal but not delivered to the user until the
66 specified time.)
67 -D Enable notification by electronic mail when the page has
69 been delivered to the service provider. This option is
70 meaningful only when communicating with a HylaFAX server.
71 -f from Use from as the identity of the message sender. Otherwise
73 the sender is the user that invoked sendpage. The sender
74 is an account name to which the HylaFAX software should
75 direct email notification messages. The from identity may
76 be a full-blown ``From:'' line, e.g. e.g. ``Joe Blow
77 <joe@foo.com>'' and ``joe@foo.com (Joe Blow)'' are accept‐
78 able. If no host-part is specified in the from string the
79 local hostname is used. This option is useful when send‐
80 page is invoked on behalf of another user, such as in the
81 implementation of an electronic mail to pager gateway.
82 -h [modem@]host[:port]
84 Force the jobs to be processed on a specific host and,
85 optionally, using a particular modem. The host may be
86 either a symbolic name or a network address. IPv6
87 addresses are given in ``[xx:xx::x]:port'' format. If no
88 -h option is supplied, sendpage uses the SNPPSERVER envi‐
89 ronment variable to identify the SNPP server to which the
90 pages should be directed. If no server is specified then
91 sendpage attempts to contact a server on the local host.
92 If no modem is specified, the job will be submitted to any
93 available modem.
94 -I time If a job must be requeued because of a communication fail‐
96 ure schedule the retry according to the specified time.
97 Times are given in seconds. Minutes, hours, and days can
98 be specified with ``min'', ``hour'', and ``day'' suffixes,
99 respectively. By default HylaFAX reschedules jobs using
100 retry times that depend on the manner in which the job
101 failed; this interface permits a user to override this
102 algorithm and specify a single fixed retry time for all
103 communication failures. This option is meaningful only
104 when communicating with a HylaFAX server.
105 -l level Specify a particular service level to use in delivering a
107 page. A service level defines both a scheduling priority
108 and the time that a client is willing to wait to find out
109 if delivery is successful or not. Normal delivery is
110 obtained with level 1 (default). The SNPP specification
111 identifies level 0 as the highest priority service level
112 with levels 1-7 lower priority and levels 8-11 ven‐
113 dor/server-specific. For HylaFAX server machines the map‐
114 ping between service level and scheduling priority is
115 defined by the configuration of the SNPP server process;
116 see the PriorityMap parameter in hfaxd(8C)
117 -n Send to a numeric-only paging device; i.e. do not send a
119 text message in the paging request.
120 -N Do not notify the sender by electronic mail when the page
122 has been delivered to the service provider (default). This
123 option is meaningful only when communicating with a HylaFAX
124 server.
125 -O config Treat config as a configuration parameter specification
127 that is interpreted after reading the configuration file.
128 For example, ``-O Host:fax.example.com'' would set the Host
129 configuration parameter to ``fax.example.com'', overriding
130 any setting in the configuration file.
131 -p PIN The Pager Identification Number (PIN) for a terminal that
133 is to receive the message. A message can be sent to multi‐
134 ple destinations by specifying multiple -p options.
135 -q Mark pages to be queued on the server and do not wait for
137 their delivery. By default sendpage conforms to the SNPP
138 spec by synchronously waiting for each page to be deliv‐
139 ered. This option instructs sendpage to submit one or
140 pages and then terminate immediately without waiting for
141 their completion. When pages are queued it is advisable to
142 enable email notification with the -D or -R options. Job
143 queueing is a non-standard function of the SNPP implementa‐
144 tion in HylaFAX and is not available when submitting pages
145 to non-HylaFAX servers.
146 -R Enable notification by electronic mail when the message has
148 been delivered and when it is requeued for retransmission.
149 HylaFAX will always notify the sender by electronic mail if
150 there is problem delivering a page (irregardless of the
151 email notification setting). This option is meaningful
152 only when communicating with a HylaFAX server.
153 -s subject Set the ``subject'' for the specified pages according to
155 subject. For HylaFAX subject is used as the identifier
156 string returned in any email notification messages (instead
157 of the usual job identifier number). This option is useful
158 for applications that cross reference notification messages
159 against job submissions.
160 -t tries Make no more than tries attempts to send the page. By
162 default, HylaFAX will terminate a job if: 3 consecutive
163 attempts to send a particular message fail, or it appears
164 the receiver is not a service provider. Otherwise HylaFAX
165 places no limit on the number of attempts to send a page,
166 instead terminating a job if it is not completed within a
167 fixed period of time specified by the service level. Note
168 that a try is a phone call in which carrier is established
169 and the IXO/TAP or UCP protocol is commenced; this is con‐
170 trasted with a call attempt that might have failed because
171 the line was busy. This option is meaningful only when
172 communicating with a HylaFAX server.
173 -T dials Make no more than dials phone calls when attempting to send
175 a page. By default, HylaFAX will terminate a job if: 12
176 attempts to reach a service provider fail, or it appears
177 the receiver is not a service provider. Otherwise HylaFAX
178 terminates a job if it is not completed within a fixed
179 period of time specified by the service level. This option
180 is meaningful only when communicating with a HylaFAX
181 server.
182 -v Trace the protocol between sendpage and the SNPP server
184 process that does the delivery work on the remote machine.
185 This information is directed to the standard output.
186
188 sendpage reads configuration information from the files
189 /etc/hylafax/hyla.conf, /etc/hylafax/sendpage.conf, and ~/.hylarc; in
190 that order. Configuration files follow the conventions described in
191 hylafax-client(1). The following configuration parameters are recog‐
192 nized:
193 Tag Type Default Description
194 HoldTime string - hold time to assign to pages
195 Host string localhost host to contact for service
196 MailAddr string - mail address for notification messages
197 MaxDials integer 12 times to retry dialing
198 MaxTries integer 3 times to retry transmission
199 Notify string none control email notification
200 Port integer 444 port to use in contacting server
201 Protocol string tcp protocol to use in contacting server
202 QueueSend boolean No whether or not to queue pages
203 RetryTime string - delay between failed attempts to send
204 ServiceLevel integer SNPP service level for pages
205 Verbose boolean No whether or not to enable protocol tracing
206 The configuration parameters are explained below:
208 HoldTime The hold time to assign to pages. (Equivalent to the -a
210 option.)
211 Host The host to contact for service. (Equivalent to the -h
213 option.)
214 MailAddr The electronic mail address to direct notification mes‐
216 sages from the server. If this string is specified
217 without an ``@hostname'' part then the local hostname
218 will automatically be appended. (Equivalent to the -f
219 option.)
220 MaxDials The maximum number of times to dial the phone for each
222 job. (Equivalent to the -T option.)
223 MaxTries The maximum number of times to retry sending a job.
225 (Equivalent to the -t option.)
226 Notify Control the email notification messages from the server.
228 This string may be one of ``done'', ``none'',
229 ``requeued'' or ``default'' with an optionally preceding
230 ``when '' (e.g. ``when done''). Note that ``when
231 requeued'' implies ``when done''. (Equivalent to the
232 -D, -R, and -N options.)
233 Port The network port to contact for service. (Equivalent to
235 the -h option.)
236 Protocol The name of the communication protocol to use when con‐
238 tacting a server. (Equivalent to the SNPPSERVICE envi‐
239 ronment variable.)
240 QueueSend Control whether or not to wait for the pages to be
242 delivered. (Equivalent to the -q option.)
243 RetryTime The time to delay between job retries due to a communi‐
245 cation failure. (Equivalent to the -I option.)
246 ServiceLevel The SNPP service level to assign to each page. (Equiva‐
248 lent to the -l option.)
249 Verbose Control protocol tracing. (Equivalent to the -v
251 option.)
252
254 The following environment variables are used by sendpage:
255 SNPPSERVER The identity of the SNPP server to contact for service.
257 This value is specified as ``[modem@]host[:port]'' where
258 host is either a host name or the Internet ``.'' (dot)
259 address of the host; port is the TCP port number or ser‐
260 vice name to use (default is ``snpp'' or 444); and modem
261 is an optional modem name or class on the server machine
262 to use in processing the requests (this is meaningful
263 only when the server is running HylaFAX).
264 SNPPSERVICE The communication service specification for communicat‐
266 ing with the SNPP server. This value is specified as
267 ``port[/protocol]''; by default ``444/tcp''.
268
270 /var/spool/hylafax/tmp/sndpageXXXXXX temporary files
271
273 The phone number of the pager service provider is stored on the server
274 machine and is not specified by the user; this is a departure from
275 pager support that was supplied with HylaFAX version 3.0.
276 HylaFAX version 3.0 used to recognize a null text message and assume
278 the destination paging device was numeric-only. This is no longer
279 true; if a null text message is submitted then a null message will be
280 included in the paging request. This may cause paging requests submit‐
281 ted to ``real SNPP'' servers to be rejected if the paging device is in
282 fact numeric-only. When sending to a numeric-only paging device the -n
283 option should be used.
284
286 It is not possible to page text- and non-text devices together; send‐
287 page must be run twice, once to send to text-capable devices and once
288 to send to non-text devices.
289
291 at(1), hylafax-client(1), faxalter(1), faxrm(1), faxstat(1), faxq(8C),
292 hfaxd(8C), hylafax-server(5F)
293 May 12, 1996 SENDPAGE(1)