1
2
3
4User Commands                                            qpage(1)
5
6
7
8NAME
9     qpage -  SNPP  client/server  for  sending  messages  to  an
10     alpha-numeric pager
11
12SYNOPSIS
13     qpage [ -dhimQv ] [ -a [+][dd+]hhmm | -a YYMMDDHHMMSS ] [ -c
14     coverage  ]  [  -f  from  ] [ -l level ] [ -p pagerid ] [ -P
15     pagerid ] [ -s server ] [ message ]
16
17     qpage [ -d ] [ -C config ] -q interval
18
19DESCRIPTION
20     QuickPage sends messages to a paging terminal using the SNPP
21     and  IXO (also known as TAP) protocols.  It is normally used
22     with no options other than a recipient and the message text,
23     in  which  case the message is sent to the SNPP server where
24     it is submitted to a page queue to be  sent  by  a  separate
25     daemon  process.   Page  groups  and duty schedules are sup-
26     ported.  Status notification messages indicating the success
27     or  failure  of  a page are sent via e-mail to submitters of
28     high-priority (level 0) pages.
29
30     If no message is specified on the command line, the user  is
31     prompted  for  the  message  text.  Characters are read from
32     standard input until a line  containing  only  a  period  is
33     received, or until EOF is received.  All occurrences of whi-
34     tespace within the message text  are  reduced  to  a  single
35     space character.
36
37     Messages received by the QuickPage daemon  that  are  longer
38     than the maximum page length (see below) are split into mul-
39     tiple segments and sent as  separate  pages.   Each  message
40     segment  is  prefixed  with its segment number.  The maximum
41     number of segments a into which a message will be  split  is
42     configurable.   If  a  message  exceeds this limit, the last
43     allowed segment will be prefixed with 't',  indicating  that
44     the  message  is  truncated;  otherwise, the last segment is
45     prefixed with 'e' to indicate the end of the message.   Mes-
46     sages that fit into a single page are not prefixed with seg-
47     ment numbers.  All message segments are prefixed  with  CAL-
48     Lerid information (see RFC-1861), if available.
49
50OPTIONS
51     The following options are supported:
52
53     -a   Send the page at the specified time.  A time specifica-
54          tion  prefixed  with  a  plus  sign (+) is added to the
55          current time.  The QuickPage daemon will not  send  any
56          pages  with  a  timestamp  newer than the current time.
57          This feature may be used  to  provide  a  simple  alarm
58          clock function for meeting reminders, etc.  This option
59          applies only to the pagerid(s) specified by the next -p
60
61
62
63Thomas Dwyer III      Last change: 05/08/99                     1
64
65
66
67
68
69
70User Commands                                            qpage(1)
71
72
73
74          option.   If  the  specified  time  is  in  the  format
75          YYMMDDHHMMSS, the two-digit year is interpreted as fol-
76          lows:  if the last two digits of the specified year are
77          in the range 00-49 and  the  last  two  digits  of  the
78          current  year are in the range 50-99, assume the speci-
79          fied time is in the next century.  Otherwise assume the
80          specified time is in the current century.
81
82     -c   Use a different coverage area or paging service.   This
83          option  is  only  useful if the recipient has more than
84          one pager and/or more than  one  paging  service.  This
85          option  applies only to the pagerid(s) specified by the
86          next -p option.
87
88     -C   Specify an alternate configuration file.   This  option
89          may only be used on the QuickPage server.
90
91     -d   Debug mode.  Very verbose and probably not  interesting
92          for  the  normal  user.   This  option  is provided for
93          debugging purposes only.
94
95     -f   Specify who the page is from.   This  option  specifies
96          the  argument to the SNPP CALLerid command.  Every mes-
97          sage segment will be prefixed with the value  specified
98          by this option unless disabled by the msgprefix keyword
99          in the configuration file.  A null argument  (  -f  "")
100          may  be  specified to suppress the message prefix for a
101          particular message.  However, this will  also  suppress
102          e-mail  status notification.  The default is the userid
103          of the person running QuickPage.
104
105     -h   Help.  Print  a  brief  summary  of  the  command  line
106          options.
107
108     -i   Use interactive mode.  The page is sent immediately and
109          summary  messages  are printed during the course of the
110          transaction.  This option may only be used on a machine
111          with  a  physically  attached  modem.   This  option is
112          intended for debugging purposes only and should not  be
113          used  in a production environment.  The -d option, when
114          used in conjunction  with  this  option,  can  be  very
115          effective  in troubleshooting problems between the SNPP
116          server and the remote paging terminal.
117
118     -l   Specify the service level for this page.   The  service
119          level  must  be  a  number between 0 and 11, inclusive.
120          The TME protocol specifies service level as follows:
121
122               0 - Priority
123               1 - Normal (default)
124               2 - Five minutes
125               3 - Fifteen minutes
126
127
128
129Thomas Dwyer III      Last change: 05/08/99                     2
130
131
132
133
134
135
136User Commands                                            qpage(1)
137
138
139
140               4 - One hour
141               5 - Four hours
142               6 - Twelve hours
143               7 - Twenty Four hours
144               8 - Carrier specific '1'
145               9 - Carrier specific '2'
146               10 - Carrier specific '3'
147               11 - Carrier specific '4'
148
149          With the exception of level zero, service  levels  have
150          no  meaning to QuickPage but they are accepted for com-
151          patibility with  other  programs.   Any  service  level
152          specified  by the user is passed on to the SNPP server.
153          For pages submitted with a service level of  zero,  the
154          QuickPage  daemon  will  send  an e-mail message to the
155          submitter notifying them  whether  the  page  succeeded
156          (i.e.  it  was  successfully  transmitted to the paging
157          service) or failed.  This option applies  only  to  the
158          pagerid(s) specified by the next -p option.
159
160     -m   This option tells QuickPage to read an  e-mail  message
161          from  standard  input.   A  page is constructed by con-
162          catenating the From: header (XXX), the Subject:  header
163          (YYY),  and  lines  from the message body (ZZZ) as fol-
164          lows:
165
166               XXX (Subj: YYY) ZZZ ...
167
168          Minimal support is provided  for  multipart  MIME  mes-
169          sages.    The   first  part  with  a  Content-Type:  of
170          text/plain will be processed.  The remaining parts will
171          be discarded.  This will reduce the problems associated
172          with people  accidentally  mailing  binaries  to  their
173          pagers.
174
175          The X-sun-attachment type is not supported  and  should
176          not  be  used.   MIME is a documented standard.  The X-
177          sun-attachment type is neither documented nor standard.
178          However,  QuickPage  will  still use the From: and Sub-
179          ject: lines (but no message body)  from  such  messages
180          for those people who insist on using it anyway.
181
182          A line starting with two dashes  (--)  in  the  message
183          body  (or  in  a  MIME  text part) is assumed to be the
184          start of a signature and will cause QuickPage  to  stop
185          processing the e-mail message at that point.
186
187     -p   Specify the pagerid of the intended recipient.   Multi-
188          ple  recipients  may  be  specified by separating their
189          pager        IDs        with        commas        (e.g.
190          pagerid1,pagerid2,pagerid3).   No  spaces are permitted
191          between recipients and the comma separator  characters.
192
193
194
195Thomas Dwyer III      Last change: 05/08/99                     3
196
197
198
199
200
201
202User Commands                                            qpage(1)
203
204
205
206          Any -a, -c, or -l options previously encountered on the
207          command line are reset to their  default  values  after
208          this option is processed.  This option may occur multi-
209          ple times on the command line, each  possibly  preceded
210          by different -a, -c, or -l options.
211
212     -P   Like -p but does not reset -a, -c, or -l options previ-
213          ously encountered on the command line.
214
215     -q   Start a QuickPage daemon.  This option causes QuickPage
216          to  detach itself from the controlling terminal and run
217          as a daemon process.  This option requires a  numerical
218          argument.   If  the  argument  is greater than zero, it
219          specifies the number of seconds QuickPage should  sleep
220          between queue runs.  An argument less than zero signals
221          QuickPage to accept incoming SNPP connections and write
222          new  pages  to the page queue, but to never process the
223          page queue.  An argument of zero signals QuickPage  not
224          to listen for incoming SNPP connections, but to process
225          the page queue one time and then exit.  See  the  NOTES
226          section below for more information.
227
228     -Q   Print the current contents of  the  page  queue.   This
229          option  may  only  be  used  on  the  QuickPage server.
230          Unless invoked by root or DAEMONUSER, this option  will
231          probably fail because of insufficient permissions.
232
233     -s   Specify the name(s) of the SNPP server(s).   The  host-
234          names  used  by a client to contact a server are deter-
235          mined by checking the following in this order:
236
237               the -s option
238               the environment variable SNPP_SERVER
239               the contents of the compiled in filename
240               the compiled in hostname
241
242          Multiple hostnames are  permitted  by  separating  them
243          with  commas.   If  multiple  servers  are  used, it is
244          assumed that they all have identical copies of the con-
245          figuration file.
246
247     -v   Print the version of QuickPage and exit.
248
249     The QuickPage server requires a  configuration  file.   This
250     file  is read one time during startup and again upon receipt
251     of SIGHUP.  The configuration file is made up of  major  and
252     minor keyword=value pairs.  Major keywords must start at the
253     beginning of a line.  Minor keywords  must  contain  leading
254     whitespace.   All keywords must be immediately followed with
255     an equal sign (=).  Spaces are permitted between  the  equal
256     sign  and  the value.  The value may not contain whitespace.
257     Keywords may appear in any order  with  the  following  four
258
259
260
261Thomas Dwyer III      Last change: 05/08/99                     4
262
263
264
265
266
267
268User Commands                                            qpage(1)
269
270
271
272     exceptions:
273
274          Minor keywords must be  grouped  together  under  their
275          respective major keyword.
276
277          Modems must be defined before any services that  refer-
278          ence them.
279
280          Services must be defined before any pagers that  refer-
281          ence them.
282
283          Pagers must be defined before any groups that reference
284          them.
285
286     The major keywords are:
287
288          administrator  The  e-mail  address  of  the  QuickPage
289                         administrator.    If   defined,   e-mail
290                         notification will be sent to the  Quick-
291                         Page administrator whenever a page fails
292                         (i.e. when maxtries has been  exceeded).
293                         This  address is also used in the Reply-
294                         To: header for status notification  mes-
295                         sages  sent  to  users  who submit high-
296                         priority pages.
297
298          forcehostname  (true, false, or  @mailhost)  Force  the
299                         destination address to be qualified with
300                         a hostname when  sending  e-mail  status
301                         notification  to users.  This option can
302                         be used when  the  QuickPage  daemon  is
303                         running  on a machine that does not han-
304                         dle   unqualified    e-mail    addresses
305                         correctly.  If the value of this keyword
306                         starts with the '@' character,  it  will
307                         be  appended as-is to unqualified e-mail
308                         addresses.  If the value of this keyword
309                         is  "true" then the submitter's hostname
310                         will be appended to such addresses.  The
311                         default  is  false  (do not append host-
312                         names).
313
314          identtimeout   The number of  seconds  to  wait  for  a
315                         reply   before  giving  up  on  RFC-1413
316                         queries.  An integer less than or  equal
317                         to  zero  disables  ident functionality.
318                         The default is 10 seconds.
319
320          include        If present, this keyword  specifies  the
321                         name  of another configuration file that
322                         should be processed at this point.  Pro-
323                         cessing  of  the  current  file  resumes
324
325
326
327Thomas Dwyer III      Last change: 05/08/99                     5
328
329
330
331
332
333
334User Commands                                            qpage(1)
335
336
337
338                         after the specified file has  been  pro-
339                         cessed.   QuickPage  makes no attempt to
340                         prevent infinite recursion; do  not  use
341                         this  keyword  in  multiple  files  that
342                         point at each other.
343
344          pidfile        If present,  this  keyword  specifies  a
345                         file  into which the server should write
346                         its process ID.   The  file  is  is  not
347                         opened until after root permissions have
348                         been dropped.  If DAEMONUSER cannot open
349                         the  file  for  writing  (or if the file
350                         does not exist and DAEMONUSER  does  not
351                         have permission to create it), this key-
352                         word is silently ignored.
353
354          sigfile        If present,  this  keyword  specifies  a
355                         file  containing  an alternate signature
356                         that QuickPage should append  to  e-mail
357                         status  notification  messages  sent  to
358                         page submitters.  Use  sigfile=/dev/null
359                         to suppress the signature completely.
360
361          synchronous    (true or false)  Whether  or  not  queue
362                         runs  are  synchronized  with new pages.
363                         If true, the submission of  a  new  page
364                         initiates  a  queue  run without waiting
365                         for the normal sleep counter (set by the
366                         -q  option).   If  false,  the  page  is
367                         queued and the server waits for the time
368                         remaining  on the sleep counter (if any)
369                         before starting another queue run.   The
370                         default is true.
371
372          lockdir        The  location  of  the  lock  directory.
373                         This keyword may be used to override the
374                         compiled in location of the lock  direc-
375                         tory.   It should rarely be necessary to
376                         specify this keyword.
377
378          snpptimeout    The number of seconds  to  wait  for  an
379                         SNPP command before terminating the con-
380                         nection.  The default is 60 seconds.
381
382          queuedir       The location of the page  queue.   There
383                         is  no  default  queue  directory;  this
384                         option must be specified in  the  confi-
385                         guration file.
386
387          modem          The start of a  modem  definition.   The
388                         argument  to this keyword is the name of
389                         a  modem  device  (e.g.  hayes).    This
390
391
392
393Thomas Dwyer III      Last change: 05/08/99                     6
394
395
396
397
398
399
400User Commands                                            qpage(1)
401
402
403
404                         keyword  has  the  following  minor key-
405                         words:
406
407                         text           Optional  text  specified
408                                        by   the   administrator.
409                                        This text may not contain
410                                        whitespace.      However,
411                                        underscores are converted
412                                        to  spaces when the value
413                                        of this keyword is  read.
414                                        This   keyword   is   not
415                                        interpreted by  QuickPage
416                                        and  is only provided for
417                                        the administrator's  con-
418                                        venience.
419
420                         device         The name  of  the  device
421                                        the  modem  is physically
422                                        connected  to,  such   as
423                                        /dev/cua/a.   There is no
424                                        default   device;    this
425                                        option  must be specified
426                                        in   the    configuration
427                                        file.
428
429                         initcmd        The  initialization  com-
430                                        mand for this modem.  The
431                                        initialization    command
432                                        must  cause  the modem to
433                                        respond  with  OK.    The
434                                        default    initialization
435                                        command is ATZ.
436
437                         dialcmd        The dial command for this
438                                        modem.   The dial command
439                                        specified here should not
440                                        include  a  phone number.
441                                        The default dial  command
442                                        is ATDT.
443
444          service        The start of a  paging  service  defini-
445                         tion.   The  argument to this keyword is
446                         the name of the paging  service.   If  a
447                         service named default exists, the values
448                         of  its  minor  keywords  are  used   as
449                         defaults  for  all other service defini-
450                         tions.  This keyword has  the  following
451                         minor keywords:
452
453                         text           Optional  text  specified
454                                        by   the   administrator.
455                                        This text may not contain
456
457
458
459Thomas Dwyer III      Last change: 05/08/99                     7
460
461
462
463
464
465
466User Commands                                            qpage(1)
467
468
469
470                                        whitespace.      However,
471                                        underscores are converted
472                                        to  spaces when the value
473                                        of this keyword is  read.
474                                        This   keyword   is   not
475                                        interpreted by  QuickPage
476                                        and  is only provided for
477                                        the administrator's  con-
478                                        venience.
479
480                         device         One  or  more  names   of
481                                        modem  definitions.  Mul-
482                                        tiple   modems   may   be
483                                        specified  by  separating
484                                        them with commas.  During
485                                        a  queue  run,  QuickPage
486                                        will try  each  modem  in
487                                        the  list  until it finds
488                                        one that  can  be  opened
489                                        successfully  (i.e. it is
490                                        not already being used by
491                                        a  dialin user or by some
492                                        other   process).     The
493                                        remaining  modems  in the
494                                        list  will   be   ignored
495                                        until  the next queue run
496                                        when  the  list  will  be
497                                        searched  again.   In  no
498                                        event will QuickPage ever
499                                        have  more than one modem
500                                        open at any  given  time;
501                                        pages   queued  for  dif-
502                                        ferent services  are  not
503                                        processed   concurrently.
504                                        For backward  compatibil-
505                                        ity     with     previous
506                                        releases, a physical dev-
507                                        ice path may be specified
508                                        here.  However, this will
509                                        not   be   supported   in
510                                        future  releases.   Modem
511                                        definitions   should   be
512                                        used instead.
513
514                         dialcmd        [obsolete]  The   command
515                                        that the modem should use
516                                        to connect to the  remote
517                                        paging   service.    This
518                                        keyword is  accepted  for
519                                        backward    compatibility
520                                        and will not be supported
521                                        in  future  releases.  If
522
523
524
525Thomas Dwyer III      Last change: 05/08/99                     8
526
527
528
529
530
531
532User Commands                                            qpage(1)
533
534
535
536                                        specified,  this  keyword
537                                        overrides   the   dialcmd
538                                        keyword  in   all   modem
539                                        specifications   used  by
540                                        this service.
541
542                         phone          The phone number  of  the
543                                        paging    service.    The
544                                        specified  phone   number
545                                        will  be  appended to the
546                                        modem's dialcmd when cal-
547                                        ling the paging service.
548
549                         password       The password to use  when
550                                        logging  into  the remote
551                                        paging service.  The  IXO
552                                        specification defines the
553                                        password as  an  optional
554                                        six             character
555                                        alphanumeric      string.
556                                        Most  paging  services in
557                                        the United States do  not
558                                        require  a password.  The
559                                        default   is   an   empty
560                                        string ("").
561
562                         baudrate       The speed  to  use  while
563                                        talking   to  the  modem.
564                                        The default is 300 baud.
565
566                         parity         The parity to use  (even,
567                                        odd, or none) while talk-
568                                        ing to  the  modem.   The
569                                        default is even.
570
571                         maxmsgsize     The  maximum  number   of
572                                        characters  allowed  in a
573                                        single   page    segment.
574                                        This  size  includes  the
575                                        message  prefix   and   9
576                                        bytes  of  protocol over-
577                                        head.  The default is  80
578                                        characters.
579
580                         maxpages       The  maximum  number   of
581                                        page   segments  to  send
582                                        when  a  message  exceeds
583                                        maxmsgsize.  The value of
584                                        this   option   must   be
585                                        between    1    and    9,
586                                        inclusive.   The  default
587                                        is 9 page segments.
588
589
590
591Thomas Dwyer III      Last change: 05/08/99                     9
592
593
594
595
596
597
598User Commands                                            qpage(1)
599
600
601
602                         maxtries       The number  of  times  to
603                                        attempt  sending  a  page
604                                        before giving up.  If the
605                                        modem  is  busy (i.e. tip
606                                        or cu is currently  using
607                                        it)   or   if  the  modem
608                                        returns BUSY in  response
609                                        to  the dial command, the
610                                        counter  is  not   incre-
611                                        mented.  Thus a busy ser-
612                                        vice will cause QuickPage
613                                        to  retry  the  page for-
614                                        ever.  The default is 6.
615
616                         identfrom      (true or false) This key-
617                                        word specifies whether to
618                                        use the ident response as
619                                        the  message prefix if no
620                                        CALLerid SNPP command  is
621                                        received.  The default is
622                                        true.
623
624                         allowpid       (true or false) This key-
625                                        word   specifies  whether
626                                        the QuickPage daemon will
627                                        accept  numeric  pagerids
628                                        for pagers not  specified
629                                        in    the   configuration
630                                        file.  The  default  ser-
631                                        vice  is  used  for  such
632                                        pagerids unless the  user
633                                        explicitly chooses a dif-
634                                        ferent   service.     The
635                                        default  for this keyword
636                                        is false.
637
638                         msgprefix      (true or  false)  Whether
639                                        to  prepend  the sender's
640                                        name (the CALLerid infor-
641                                        mation)  to the beginning
642                                        of  each  page   segment.
643                                        This  keyword  should  be
644                                        set to false for  service
645                                        definitions    used   for
646                                        numeric   pagers.     The
647                                        default  for this keyword
648                                        is true.
649
650          pager          The start of a  pager  definition.   The
651                         argument to this keyword is the username
652                         associated with the pager.   This  user-
653                         name  will be specified by the -p option
654
655
656
657Thomas Dwyer III      Last change: 05/08/99                    10
658
659
660
661
662
663
664User Commands                                            qpage(1)
665
666
667
668                         on the command line when running  Quick-
669                         Page  in  client mode.  This keyword has
670                         the following minor keywords:
671
672                         text           Optional  text  specified
673                                        by   the   administrator.
674                                        This text may not contain
675                                        whitespace.      However,
676                                        underscores are converted
677                                        to  spaces when the value
678                                        of this keyword is  read.
679                                        Pager specifications con-
680                                        taining this keyword will
681                                        be  listed  by  the  XWHO
682                                        SNPP  command.   See  the
683                                        NOTES  section  below for
684                                        more information.
685
686                         pagerid        The pagerid sent  to  the
687                                        remote paging service for
688                                        this pager.
689
690                         service        The  default  service  to
691                                        use for this pager.
692
693          group          The start of a  group  definition.   The
694                         argument  to this keyword is the name of
695                         a new page group.  This keyword has  the
696                         following minor keywords:
697
698                         text           Optional  text  specified
699                                        by   the   administrator.
700                                        This text may not contain
701                                        whitespace.      However,
702                                        underscores are converted
703                                        to  spaces when the value
704                                        of this keyword is  read.
705                                        Group specifications con-
706                                        taining this keyword will
707                                        be  listed  by  the  XWHO
708                                        SNPP  command.   See  the
709                                        NOTES  section  below for
710                                        more information.
711
712                         member         A member of  this  group.
713                                        The  member  must  have a
714                                        valid pager entry  before
715                                        this   group  definition.
716                                        An optional duty schedule
717                                        (see below) may be speci-
718                                        fied.  This  keyword  may
719                                        appear   multiple   times
720
721
722
723Thomas Dwyer III      Last change: 05/08/99                    11
724
725
726
727
728
729
730User Commands                                            qpage(1)
731
732
733
734                                        within a single group.
735
736     The service named  "default"  always  exists  (even  if  not
737     specified  in  the  configuration  file) and has the default
738     values listed above.  However, the default  service  may  be
739     redefined in the configuration file if desired.
740
741     Member definitions within a page group have the syntax:
742
743          member=name[/DayStart-End]
744
745     Where  the  square  brackets  indicate  an   optional   duty
746     schedule.  The duty schedule has the same syntax as the Time
747     parameter in the UUCP Systems file:  Day is a list of  case-
748     sensitive  weekday abbreviations (e.g. MoTuTh), Start is the
749     start time (e.g. 800), and End is the end time (e.g.  1700).
750     The word Any is synonymous with SuMoTuWeThFrSa. Midnight may
751     be represented as either 0 or 2400.  The time range must not
752     span  across  midnight.  A slash is required to separate the
753     duty schedule from the member name.  Multiple member defini-
754     tions  for the same person with different duty schedules are
755     permitted  (see  the  example  below).    Overlapping   duty
756     schedules  for the same person within a group will not cause
757     duplicate pages to be sent to that person.  See the  follow-
758     ing example configuration file:
759
760          #
761          # QuickPage configuration file
762          #
763          administrator=tomiii@qpage.org
764          identtimeout=5
765          queuedir=/var/spool/qpage
766
767          modem=ttya
768               device=/dev/cua/a
769
770          # use the S7 modem register to set a connection timeout
771          modem=ttyb
772               device=/dev/cua/b
773               initcmd=ATS7=45V1Q2&K0&M0
774
775          service=airtouch
776               device=ttya,ttyb
777               phone=9,9500572
778               baudrate=1200
779               allowpid=yes
780               maxtries=6
781
782          service=skytel
783               device=ttya
784               phone=9,18007596366
785
786
787
788
789Thomas Dwyer III      Last change: 05/08/99                    12
790
791
792
793
794
795
796User Commands                                            qpage(1)
797
798
799
800          service=supercom
801               device=ttya
802               phone=9,4879889
803
804          pager=tomiii
805               pagerid=1234567
806               service=skytel
807
808          pager=ginger
809               pagerid=5551212
810               service=skytel
811
812          pager=tony
813               pagerid=711
814               service=supercom
815
816          group=sysadmin
817               member=tomiii/MoWeFr800-1700
818               member=tony/TuTh800-1700
819               member=tony/SaSu900-1600
820
821NOTES
822     The order of the command line options is important.  The -a,
823     -c, and -l options must precede the pagerids they refer to.
824
825     The -p option resets -a, -c, and -l to their default  values
826     after it is processed.  If this behavior is not desired, use
827     -P instead.
828
829     All 8-bit characters are stripped to 7 bits before they  are
830     transmitted  to the paging service, regardless of the parity
831     setting defined in the configuration file.  Also,  all  con-
832     trol  characters  (ASCII  values  between 0x00 and 0x20) are
833     "escaped" as specified by the IXO/TAP protocol.  Escaping is
834     done  by  converting  each  control character into two bytes
835     consisting of a SUB (0x1A) character followed by the  print-
836     able  ASCII  character  formed  by  adding 0x40 to the ASCII
837     value of the control character.  Thus, Ctrl-A is transmitted
838     as the two-byte sequence 0x1A, 0x41.
839
840     The QuickPage daemon listens for incoming  SNPP  connections
841     and periodically processes the page queue.  A separate child
842     process is created on demand to handle each incoming request
843     and each queue run.
844
845     After a page is accepted, the child  sends  SIGUSR1  to  its
846     parent  forcing  it to start a queue run immediately without
847     waiting for the time specified by -q.  If desired, this sig-
848     nal  can  be  suppressed  using  the  "synchronous"  keyword
849     described above.
850
851
852
853
854
855Thomas Dwyer III      Last change: 05/08/99                    13
856
857
858
859
860
861
862User Commands                                            qpage(1)
863
864
865
866     The page queue is locked during queue runs to prevent multi-
867     ple processes from competing for modem resources.
868
869     The QuickPage SNPP daemon supports a proprietary  XWHO  com-
870     mand  not  documented  in  the  official  SNPP  protocol  as
871     described in RFC-1861.  XWHO takes no arguments and  returns
872     a multi-line response of the form:
873
874          214 pager1 text1
875          214 pager2 text2
876          214 pager3 text3
877           .
878           .
879           .
880          214 pagerN textN
881          250
882
883     where the first word after the 214 response code is the name
884     of  a  pager  or  page  group,  followed by the value of the
885     corresponding text keyword (with  underscores  converted  to
886     spaces)  from  the  configuration  file.   Pager  and  group
887     specifications that do not have the text keyword defined  in
888     the  configuration  file  will  not  be included in the XWHO
889     response.  The purpose of the XWHO command is to allow  SNPP
890     clients  to present users with a list of possible recipients
891     and their names  or  descriptions.   XWHO  is  supported  by
892     QuickPage  in  an  attempt  to  overcome  the  current  SNPP
893     protocol's deficiency.  If the protocol is ever  revised  in
894     the  future  to  include this functionality, support for the
895     XWHO command will be dropped in favor of whatever facilities
896     are  specified  at  that  time.  Software developers writing
897     their own SNPP clients should be advised that the XWHO  com-
898     mand  is  not stable and may be removed from future releases
899     of QuickPage without notice.
900
901     If the CALLerid information received by the QuickPage daemon
902     contains  the '@' character, it is truncated at that charac-
903     ter before being prepended to messages.  However, it is used
904     as-is for the destination address when sending e-mail notif-
905     ication for high-priority recipients.
906
907     Due to the protocol limitations of SNPP,  QuickPage  derives
908     e-mail notification addresses from the CALLerid information.
909     Since the CALLerid information might be  bogus,  all  e-mail
910     notifications are sent using a null reverse path.  This will
911     prevent error messages from being generated by the mail sys-
912     tem if a bogus address is used for e-mail notification.
913
914     If the server does not receive a CALLerid command  (sent  by
915     the QuickPage client unless -f"" is specified on the command
916     line) notification messages will not be sent, regardless  of
917     the specified service level.
918
919
920
921Thomas Dwyer III      Last change: 05/08/99                    14
922
923
924
925
926
927
928User Commands                                            qpage(1)
929
930
931
932     When the -m flag is used to send a high-priority  page,  the
933     status  notification  is  sent  to the return address in the
934     original e-mail message unless overridden by the -f option.
935
936     The length of SNPP commands is limited only by the amount of
937     memory available to QuickPage.
938
939     QuickPage uses a timeout of 255 seconds while waiting for  a
940     connection  from the remote modem.  This allows the adminis-
941     trator to specify an  appropriate  timeout  by  setting  the
942     modem's S7 register in the dial command.
943
944     The modem must control the CD (carrier-detect) line.  Other-
945     wise,  the  on/off hook status of the modem cannot be deter-
946     mined.  This is especially important if more than one paging
947     service  is used since QuickPage must be able to detect when
948     it's safe to send dial commands to the modem.
949
950FILES
951     /etc/qpage.cf
952
953SEE ALSO
954     RFC-1861
955
956KNOWN BUGS
957     Pages are not queued on the client side.  As a result, if no
958     servers  are  available  to the client at the time a page is
959     submitted, an error message is printed and the page is  dis-
960     carded.
961
962     Pages received after a queue run has  started  will  not  be
963     processed until the following queue run.
964
965     The default service requires a phone keyword (just like  the
966     rest  of  the service definitions), even if no pager entries
967     specifically reference the default service.
968
969     Because QuickPage must read the configuration file to deter-
970     mine the location of the page queue, the -Q option will only
971     work for users with appropriate access to the  modems,  page
972     queue, and lock directory.
973
974     Please send additional bug reports to tomiii@qpage.org.
975
976AUTHOR
977     QuickPage was written by Thomas Dwyer III <tomiii@qpage.org>
978     and is provided to the internet community free of charge for
979     non-commercial use (i.e.  QuickPage may not be used for pro-
980     fit in any way without prior written permission.)
981
982     Copyright (c) 1995-1999 Thomas Dwyer III
983
984
985
986
987Thomas Dwyer III      Last change: 05/08/99                    15
988
989
990
991