home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 7 / FreshFishVol7.bin / bbs / comm / cyberpager-1.5.lha / CyberPager / DOCUMENTATION < prev    next >
Text File  |  1994-10-05  |  17KB  |  417 lines
  1.                                 CyberPager
  2.  
  3.                 Copyright © 1993 by Christopher A. Wichura
  4.                            All rights reserved.
  5.  
  6. LEGAL MUMBO JUMBO
  7. =================
  8.  
  9. The CyberPager software is not in the public domain.  All source files, along
  10. with the resulting executable, are copyright by C.  Wichura.  You many not
  11. sell CyberPager.  The only allowed charge that may be placed on the CyberPager
  12. software is for media and/or mailing costs.
  13.  
  14. The CyberPager software may be freely redistributed via BBSs,
  15. InterNet/Usenet, and disk libraries such as Fred Fish's, as long as the
  16. archive is not modified.  Disk magazines and services that charge extra for
  17. file transfers may not distribute CyberPager.
  18.  
  19. In using the CyberPager software, you accept the responsibility for any
  20. damage or loss of productivity/money that may occur through or during its
  21. use.  C.  Wichura is not and cannot be held accountable.
  22.  
  23. QUICK DOCKS FOR CYBERPAGER
  24. ==========================
  25.  
  26. Please excuse the crude format of these docs.  I don't have a lot of free
  27. time available these days, and so can not take the time to create a full
  28. AmigaGuide doc file right now.  Sorry.
  29.  
  30. WHAT IT DOES
  31. ============
  32.  
  33. The CyberPager software allows one to send alpha-numeric pages from one's
  34. Amiga.  This is accomplished by dialing into an IXO protocol compliant
  35. pager central and uploading messages.
  36.  
  37. FEATURES
  38. ========
  39.  
  40. o   Aliases file allows for commonly paged people to be refered to by
  41.     name rather than having to remember cryptic PIN numbers.
  42.  
  43. o   Groups file allows one to create "groups" allowing messages to
  44.     be easily sent to many people working on the same project, in the
  45.     same department, etc.
  46.  
  47. o   Supports multiple pager centrals through a Services configuration
  48.     file.
  49.  
  50. o   Any number of messages can be spooled to disk to be uploaded in
  51.     a single call to a service.
  52.  
  53. o   Automatically breaks long messages up into seperate pages.  Individual
  54.     preferences for maximum message length can be set for each account
  55.     listed in the aliases file.
  56.  
  57. o   Dialer supports multiple modems and knows how to hunt down a free
  58.     modem in priority order.
  59.  
  60. o   Full logging of messages spooled, dialout attempts, etc.
  61.  
  62. o   Supports the OwnDevUnit.library method of locking serial devices,
  63.     making the dialer compatible with mith Amiga UUCP, Welmat, and
  64.     many major Amiga terminal programs.
  65.  
  66. SYSTEM REQUIREMENTS
  67. ===================
  68.  
  69. Any Amiga running AmigaDOS 2.0 or higher.
  70. A Hayes compatible modem.
  71. OwnDevUnit.library v2.1 or higher must be installed (v3.3 is included
  72.     with this distribution for those that don't already have ODU)
  73.  
  74. Highly recommended:
  75.     A hard drive
  76.     A cron program (job scheduler) of some sort, such as CyberCron.
  77.  
  78. THEORY OF OPERATION
  79. ===================
  80.  
  81. The CyberPager software is comprised mainly of two programs: SpoolPage and
  82. DialIXO.  Additional functionality can be provided by using various rexx
  83. scripts to interface other applications to the CyberPager software.  A few
  84. such scripts designed for use with Amiga UUCP are included.  Additionally,
  85. a script to page a person currently on call given current system time is
  86. also provided.  See the rexx/README file for more information on the rexx
  87. scripts provided.
  88.  
  89. Messages are sent using the SpoolPage program.  SpoolPage is responsible
  90. for figuring out who the message is going to, translating 8-bit characters
  91. to 7-bit "best" equivalents (such as ã -> a), breaking the message into
  92. multiple pages (if needed), and finally spooling the message to disk.
  93.  
  94. Once a message has been spooled, the DialIXO program is used to actually
  95. dial the pager central and upload all messages waiting for that service.
  96. DialIXO knows how to scan the spool directory to see which services have
  97. messages and will only dial out if it needs to deliver a message.
  98.  
  99. USING SPOOLPAGE
  100. ===============
  101.  
  102. SpoolPage understands the following arguments:
  103.  
  104.     TO/M/A,URGENT/S,LOGLEVEL/N/K,MESSAGE/F
  105.  
  106.     TO
  107.     used to specify the person or persons the message is for.
  108.     SpoolPage will first check to see if a name is listed in
  109.     the groups file.  If it is, it will try sending the page
  110.     to all people listed as part of that group.  If the name
  111.     is not found in the groups file, the aliases file will be
  112.     checked before an error is reported.
  113.  
  114.     messages can be spooled to people not in the aliases file
  115.     by entering an address in the form of:
  116.  
  117.         <service name>:<pin number>
  118.  
  119.     where <service name> is the name of a service found in the
  120.     services file and <pin number> is the pager number you
  121.     want to send the page to.
  122.  
  123.     URGENT
  124.     If specified, SpoolPage will try to start DialIXO after spooling
  125.     the message to disk.  The ALWAYSURGENT flag in the config file
  126.     can be used to force this option to always be on if desired.
  127.  
  128.     LOGLEVEL
  129.     controls the level of log output.  Higher numbers give more
  130.     output.  The current version of SpoolPage does not log
  131.     much extra when a level higher than default is used, so
  132.     this option is of dubious use at the moment.
  133.  
  134.     MESSAGE
  135.     if the message keyword is given, everything following it on
  136.     the command line will be interpreted as the text of the
  137.     message to be sent.  if the message keyword is not given
  138.     then SpoolPage will read the message text from it's standard
  139.     input, allowing one to pipe messages into SpoolPage.
  140.  
  141. USING DIALIXO
  142. =============
  143.  
  144. DialIXO understands the following arguments:
  145.  
  146.     SERVICE/K,MODEM/N/K,LOGLEVEL/N/K
  147.  
  148.     SERVICE
  149.     limits DialIXO to only checking if work exists for the
  150.     service listed.  Normally DialIXO tries to scan every
  151.     service for work pending.
  152.  
  153.     MODEM
  154.     allows one to specify a specific modem (as listed in the
  155.     configuration file) to try and dial out on.  when a modem
  156.     is specified, DialIXO will wait indefinately for the
  157.     modem to become free.  If no modem is specified, or
  158.     modem 0 is specified, DialIXO will try to hunt for a
  159.     modem currently not in use.  If no modem is available,
  160.     DialIXO will exit.
  161.  
  162.     LOGLEVEL
  163.     similar to the LOGLEVEL option in SpoolPage.  If you are having
  164.     trouble connecting to a service reliably, try using
  165.     loglevel 5.  This will dump all packets received from the
  166.     service into the log file and may aide you in determining
  167.     why things are failing (assuming you know what IXO result
  168.     packets are supposed to look like, of course... :->)  As of
  169.     release 1.1, DialIXO at loglevel 4 or higher will now log
  170.     each packet it is sending to the service as it uploads messages.
  171.  
  172. INSTALLING THE SOFTWARE
  173. =======================
  174.  
  175. Make a directory where you want the pager software to be located.  Assign
  176. PAGER: to this directory.  You'll also probably want to add this assign to
  177. your user-startup (or however you handle assigns at boot time; I use
  178. BindNames, for example).  Make a directory called libs in PAGER:.  Copy
  179. the pager-support.library to this directory.
  180.  
  181.     NOTE!  pager-support.library should __NEVER__ be placed in your
  182.     LIBS: directory.  SpoolPage and DialIXO expect it to be
  183.     located in PAGER:libs!
  184.  
  185. Choose a place for the spool directory.  The software defaults to
  186. PAGER:spool, however, this can be changed via an entry in the configuration
  187. file.  Make the directory.  It is perfectly legal to point the spool
  188. directory somewhere in RAM:.  However, if you do this, spooled pages not
  189. delivered by DialIXO will be lost when the system reboots.
  190.  
  191.     IMPORTANT!  If the spool directory does not exist, the software
  192.     WILL NOT BE ABLE TO SPOOL PAGES.
  193.  
  194. If you do not have OwnDevUnit.library installed on your system, copy it to
  195. LIBS: (not PAGER:libs).
  196.  
  197. Now you need to edit the following files (see the sample files provided for
  198. their format):
  199.  
  200.     PAGER:services
  201.     describes the various services that you need to connect to.
  202.     for each service, you need to indicate a name that it will be
  203.     known by to the rest of the CyberPager software, the phone number
  204.     to dial to connect to the service, the maximum baud rate the
  205.     service operates at (1200 in most cases these days, although
  206.     some are still limited to 300 and one or two support 2400),
  207.     the maximum page size the service supports (call the technical
  208.     support folks at your service to find this out -- in general,
  209.     most services only support page sizes between 196-230 bytes,
  210.     even though the