home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / comm / fido / spot / rexx / request / request.doc next >
Text File  |  1994-02-05  |  7KB  |  199 lines
  1.  
  2.                                __  ___
  3.                                |_)( |_)
  4.                                |  _)| \
  5.                            S O F T W A R E
  6. ______________________________________________________________________
  7.  
  8.    Presents: Request Handler
  9. Description: Processes netmails and sends appropriate text file back.
  10. Requirement: Registered copy of Spot
  11.     Version: 2.0
  12.        Date: 19/01/94
  13.  
  14.       Status: Freeware.   
  15. Contribution: n/a
  16.  
  17.  Acknowledge: Spot, Nico Francois; Arexx, William S. Hawes
  18. ______________________________________________________________________
  19.  
  20.                "There's an old Mechanoid saying..."
  21.  
  22. Brief ________________________________________________________________
  23.  
  24. Request Handler allows you to set up files to be sent when people
  25. send a netmail to a specific name with a list of files they want.
  26. It can currently only handle text files, but UUencoded files are
  27. okay as long as they are pre-encoded, I hope to make a version
  28. where this is not necessary.
  29.  
  30. FEATURES
  31. ¯¯¯¯¯¯¯¯
  32. o Can be setup for more than one netmail area.
  33. o Can be used with multiple files.
  34. o Origin, name they send message to, and name sent on reply are
  35.   customizable.
  36. o Subject line customizable for individual files.
  37. o Unread flag cleared on messages where a message has been
  38.   written back, ie. the request has been sucessful.
  39. o Unread flag not cleared on messages with 'UNREAD' in the
  40.   subject line.
  41. o Now works.
  42.  
  43. o Now allows Dos or Arexx scripts/commands to be issued remotely.
  44.  
  45. Usage ________________________________________________________________
  46.  
  47. INSTALLING REQUEST
  48. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  49. The script can be copied to where you keep all of your Spot scripts
  50. (usually REXX:, although mine are kept in Rexx:Spot).  The script can
  51. be run from the option 'Execute Script' from the 'Arexx' menu or else,
  52. and this is a better option, it can be installed directly to the Arexx
  53. menu.  To do this, see the Spot documentation.
  54.  
  55. SETTING UP REQUEST
  56. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  57. Due to the lack of a prefs editor (one planned), it's a li'll bit
  58. fiddly setting up, although nothing too bad.  In order to use
  59. Request.spot you'll need a prefs file which is stored in ENVARC:.
  60.   Create the file "Request.prefs" in ENVARC:, or copy the example
  61. prefs file there and edit it to your suiting.
  62.   The first line in the prefs file must be (no blank lines before)
  63. "Request Handler (19.01.94)" otherwise you'll be told the prefs
  64. file isn't compatible.  
  65.  
  66. Now, the order of the next lines makes no difference (I've finally
  67. worked out why Niço used this method, it saves a hellova lot of
  68. time and makes the prefs file a lot easier to read).
  69.  
  70.  TONAME=
  71.  
  72. This is the name the messages will need to be sent to by people
  73. requesting.  It can be anything you like but I'd advise against
  74. setting it the same as your name or all of your netmail messages
  75. will be checked, which I must admit, isn't fast.
  76.  
  77.  FROMNAME=
  78.  
  79. In the same way, this sets the name that request will be sent by.
  80. This you could set to your name but to save confusion at the other
  81. end, it can be set the same as the to name.
  82.  
  83.  ORIGIN=
  84.  
  85. This line makes little difference in netmail areas, but is useful
  86. if you are lucky enough to be able to run the request handler in
  87. a local message area.  This will be used as the origin of the
  88. request replies.
  89.  
  90.  AREA=
  91.  
  92. There may be as many of these as you like (and memory permits).
  93. Follow it with the NET NAME of the area you would like checked.
  94. Get permission before using in echoes.
  95.  
  96.  AREA=NET_2_254_149_3
  97.  AREA=NET_1_234_567_8
  98.  
  99.  ENTRY=
  100.  
  101. These lines (any number), determine the requests themselves.
  102. They should be entered in this format:
  103.  
  104.  TEXT,Name,File,Subject Line
  105.  DOS,Name,File
  106.  
  107. TEXT means that the request of name 'Name' will look for an
  108. ascii file called 'File' and send it to the requester
  109. with the message subject line set to 'Subject Line'.
  110.   For example: if the entry is as follows:
  111.  
  112.  TEXT,Req,T:Request.spot,This is Request
  113.  
  114. Then the requester must send a request with the word 'Req'
  115. alone on a line somewhere in the body text.  Advist requesters
  116. against adding huge amounts of text as this slows the process
  117. down considerably.
  118.   DOS entries work the same except the requester will not
  119. receive any confirmation.
  120.   Avoide using commas as these determine the where each
  121. piece of data starts and ends.
  122.  
  123. USING REQUEST
  124. ¯¯¯¯¯¯¯¯¯¯¯¯¯
  125. Using is the simplest.  Simply call the program straight after
  126. importation as it will only check unread mail.  The unread
  127. flag will not be affected.  _Import.spot can be editted to auto
  128. check after import by creating a script such as:
  129.  
  130.  /* Auto check */
  131.  Address Spot
  132.  'Import CLOSEWIN'
  133.  'Rexx:Spot/Request.spot'
  134.  
  135. EXTERNAL USAGE
  136. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  137. Outsiders can request files by sending a message so that it
  138. will end up in one of the areas you specified in the prefs file ie.
  139. by sending the message via netmail usually.  The 'to' line must be
  140. set to the TONAME specified in the prefs file otherwise the
  141. message will be ignored.  The magic file names should be placed
  142. in the body text, one per line, alone:
  143.  
  144.  Request
  145.  Welcome
  146.  MyFile
  147.  
  148.   If the user wishes to add extra text to the message they can do
  149. so providing that the lines do not start with magic filenames.
  150. Perhaps all names should be prefixed with a symbol to prevent this
  151. ie. *, this can be done easily by prefixing the names in the prefs
  152. file. eg.
  153.  
  154.  TEXT,*Request,Dh1:Request.spot,Voila
  155.  
  156.   If the user wants to make sure that the text is read, they
  157. can set the subject line to UNREAD which means the message will
  158. remain unread even after being processed.  The word 'unread'
  159. may appear anywhere on the subject line.
  160.  
  161. Future Enhancements __________________________________________________
  162.  
  163. o Clear Unreplied flag.
  164. o Allow files to be UUEncoded by the script.
  165. o Somehow allow Arexx commands to be run.
  166. o Have some sort of monitoring, log files perhaps.
  167. o Ignore text after the tearline.
  168.  
  169. Disclaimer ___________________________________________________________
  170.  
  171. o I am not responsible to any damage caused through the use or misuse
  172. of this product and so it must only be used at your own risk.  All
  173. efforts have been made to ensure the stability of the program but
  174. this does not mean it is 100% safe.  Please backup any important data
  175. that could be damaged through the use of this software until you are
  176. sure that it is stable...Amen.
  177.  
  178. Donations/Comments ___________________________________________________
  179.  
  180. Any comments or donations can be sent to:
  181.  
  182.  PSR Software
  183.  Paul Ruane
  184.  26 Birdwood Close,
  185.  Selsdon, Surrey.
  186.  CR2 8QG.
  187.  
  188. I may also be contacted at the following addresses as Paul Ruane:
  189.  
  190.  Fidonet_____
  191.  2:252/149.3
  192.  2:253/516.12
  193.  
  194.  Amiganet____
  195.  39:135/14.3
  196.  39:135/13.12
  197.  
  198. _________________________________________________________________NULL_
  199.