home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / comm / fido / spot / rexx / areafixman / areafixman.doc < prev    next >
Text File  |  1994-07-24  |  13KB  |  294 lines
  1.  
  2.                                __  ___
  3.                                |_)( |_)
  4.                                |  _)| \
  5.                            S O F T W A R E
  6. ______________________________________________________________________
  7.  
  8.    Presents: AreaFix Manager (AFM)
  9. Description: An Arexx script to handle AreaFixes
  10. Requirement: Registered copy of Spot
  11.     Version: 3.0
  12.        Date: 01/08/94
  13.  
  14.       Status: Freeware.   
  15. Contribution: n/a
  16.  
  17.  Acknowledge: Spot, Nico Francois; Arexx, William S. Hawes
  18. ______________________________________________________________________
  19.  
  20.   "It is custom with new users to send their areafixes to the largest
  21. of the echoes available to them..."
  22.  
  23. Brief ________________________________________________________________
  24.  
  25. AreaFix Manager, or AFM is an Arexx script for use with Spot which
  26. automizes the sending of AreaFixes.  A preference file is created and
  27. modified to hold the password and name of area, for each of your
  28. netmail areas so that to send a netmail, you simply have to enter the
  29. echoes you wish to attach and detach to/from.
  30.  
  31. NEW FEATURES
  32. ¯¯¯¯¯¯¯¯¯¯¯¯
  33. o Attach much simpler, via Areafix area list
  34.  
  35. FEATURES
  36. ¯¯¯¯¯¯¯¯
  37. o Remembers password and boss address for every netmail (matrix area)
  38. o Simple to use menu
  39. o Allows you to enter up to 15 attaches/detaches per message
  40. o Area list may be requested from within AFM
  41. o Detaching via list of areas
  42. o Works with most Areafix programs, easily customizable to different
  43.   Areafix names ie, Areafix, Areamanager etc.
  44. o Optional comment for each area which appears on the options menu.
  45. o Allows any password line option to be used (thanks to Richard
  46.   Galezowski)
  47.  
  48. UPGRADING
  49. ¯¯¯¯¯¯¯¯¯
  50. o No special upgrading required from version 2.9
  51. See Upgrading below...
  52.  
  53. Usage ________________________________________________________________
  54.  
  55. INSTALLING AFM
  56. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  57. The script can be copied to where you keep all of your Spot scripts
  58. (usually REXX:Spot).  For descriptions on how to run/install the
  59. Arexx script in the Arexx menu, see the Spot documentation.
  60.  
  61. SETTING UP AFM
  62. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  63. To use AFM you simply select the menu option like any other (providing
  64. you have chosen to install the script as instructed above.)  Once you
  65. have done this you may be told a number of things such as "Do not use
  66. from arealist".  AFM is designed to be used from the Message List
  67. screen or the Message reading screen.  Also, it should be used from
  68. Netmail areas (these are by default labelled NET_xxxxx, where xxxxx is
  69. your address).  It MAY be called from other areas, but this is not
  70. wise as it will tell everyone who gets that area your password so that
  71. they can pretend to be you!
  72.    Once inside your netmail area, simply call the program.  You will
  73. probably be told "A new prefs file has been created" or else that the
  74. program cannot create the file.  If it is the latter, make sure there
  75. is an assign called ENVARC: and ENV:.  Click on 'Ok' and you will be
  76. asked for the address of your boss.  Whatever you do, DO NOT type in
  77. the road and city of your employer :-).  What it requires is for you
  78. to enter the person who sends you your mail's address ie. 2:253/516
  79. is mine. Enter it in and press Return or click on 'Ok' and another 
  80. window will pop up.  This is for your password.
  81.    Enter the password you have arranged with your boss to use.
  82. Beware, make sure that this is the correct one as you will have two,
  83. one for use with your mailer (ie. Trapdoor) and one for use with
  84. Areafix - but often these are the same.  Check first though.  Once you
  85. have entered the password in, hit Return or click 'Ok'.
  86.    The next piece of information you must enter is the name of the Areafix
  87. program.  This is the name which you would send Areafixes to, the name
  88. you use in the 'to' field.  Usually this is 'Areafix' (the default)
  89. although you may change it to whatever your board uses.  Simply hit
  90. Return or click 'Ok' to keep the default setting.
  91.    The next window will ask you for an optional comment.  This
  92. comment will appear on the menu and is useful for reminding you which
  93. board the areafix will go to, and whether the area is Fidonet or
  94. Amiganet etc.  It may be left blank where it will be replaced with
  95. 'Options'.
  96.    AreaFixMan also has an 'announce' feature which sends a message
  97. to each area as you detach from them.  See the using AFM section
  98. for details on how it works.
  99.    You will be asked if you want to add the details to your prefs
  100. file.  Select 'Use' to save your settings to RAM: this will mean that
  101. they will be erased when you reboot.  Selecting 'Save' will save the
  102. settings to disk so that they are used every time you load AreaFixMan.
  103. This works the same way as the WB2.0+ prefs settings.
  104.    If you later find that the details are wrong, delete the files
  105. ENVARC:AreaFixMan.prefs and ENV:AreaFixMan.prefs and do this 'Setting Up'
  106. section again.  'Cancel' will result in the password etc. not being saved,
  107. so you will need to repeat the above section next time.
  108.    If you do not wish to send an AreaFix now, simply click on 'Cancel'
  109. from the attach/detach menu that follows.
  110.  
  111. USING AFM
  112. ¯¯¯¯¯¯¯¯¯
  113. Once you have set AFM up it is done forever!  Or until you need to
  114. change something where you will have to delete the prefs file and
  115. start again.  After setting up, or when you select AFM from the menu,
  116. you will be presented with a requester with four options.  Your
  117. comment, if you chose to have one, will be shown in the title bar.
  118.    Attach brings up a requester where you must select either to
  119. attach manually (type the name of the areas) or via the message.
  120. This second option is extremely useful, it allows you to attach to
  121. areas via the list of areas which is usually requestable from your
  122. boss (see below).
  123.   Attaching manually brings up a string requester where you can
  124. type the area you want to attach to (don't type '+' or '-' before
  125. it!).  After entering one in and hitting Return or clicking 'Ok' the
  126. requester will re-appear allowing you to add multiple areas.
  127. When you have done, click 'Ok' or hit Return on an empty requester, or
  128. else click 'Cancel'.  You will be taken back to the requester where you
  129. can decide to attach/detach further areas.
  130.    To attach via a message, you must go to the appropriate message
  131. before running AFM.  Select the appropriate option and then you will
  132. be taken to the Workbench and Ed will be loaded, the current message
  133. will then be loaded.  To select the areas, simply place a '~' (tilde)
  134. character directly before its name as shown below:
  135.  
  136.   a Spot           | Area for general Spot discussion
  137.  
  138. would become:
  139.  
  140.   a~Spot           | Area for general Spot discussion
  141.  
  142. This can be done for up to 15 areas.
  143.    Detaching is even easier and is done via an arealist.  A small
  144. window will pop up from which you can select an area to detach from.
  145. The requester will repeatedly pop up until cancel is selected, so when
  146. you have finished, select 'Cancel'.  As soon as you have selected
  147. okay to detach from an area, a message will be placed in the area
  148. if you have announcment switched on.  This message can be anything
  149. you like and is found in Rexx:Spot (edit the variable line in the
  150. script if this is not suitable) and is called AreaFixMan.announce.
  151. A sample announcement has been included.  Whether you ultimately
  152. decide to 'erase' any detaches, or to 'Cancel' the whole AFM
  153. session altogether the announcement will still be there, so it
  154. will be necessary to remove them manually if this is the happens.
  155.    When you have finished, simply select 'Okay'.  You will be asked
  156. if you want to request an arealist.  If your board supports it, you
  157. can click 'Yes' and then you will receive a list of all the areas
  158. available to you when your boss board has processed the message.  Even
  159. if you haven't attached to, or detached from ANY areas, you can still
  160. 'claim' your free arealist...simply send back the 'Yes' envelope...or
  161. better still click on 'Yes' when you are asked if you want one :-).
  162. Also, by selecting 'Other' from the arealist requester, you can enter
  163. in any other options such as '-H' for help or '-Q' for a query list
  164. IF, and only if, your board supports it.  Make any changes additions
  165. etc and select 'Okay' to keep the new password line options or 'Cancel'
  166. which will abort the message.
  167.    The last option from the requester arealist requester is 'Cancel' which
  168. will simply abort the message.
  169.    After adding an entry, ie. attaching or detaching to/from and area, a
  170. new option will become available.  This is called 'Erase' and will erase
  171. the last entry in the list when clicked upon (or activated via the
  172. keyboard equivalent 'E').  Repeatedly selecting this option will erase
  173. the last entry until the list is empty when the 'Erase' option will
  174. again disappear.
  175.    There is a maximum of 15 entries permitted.  This is not because it is
  176. impossible to add any more, but because the requester get's a little too big
  177. and clumsy if it exceeds this size.  When you reach the 15 entry limit, the
  178. 'Attach' and 'Detach' options will disappear and you will be left with 'Erase',
  179. 'OKAY' and 'CANCEL'.
  180.  
  181. EXAMPLE
  182. ¯¯¯¯¯¯¯
  183. Here's an example.  If I wanted to set up AFM:
  184.  
  185. 1) Enter my Netmail area.
  186. 2) Select AreaFixMan from the menu.
  187. 3) I will be told a new prefs file has been created. Click on okay.
  188. 4) Enter my boss number into requester.
  189. 5) Enter password into requester.
  190. 6) Hit RETURN to accept 'Areafix' as the TO field of Areafix messages.
  191. 7) Select OKAY to not have a comment.
  192. 8) Select SAVE to save the prefs.
  193. 9) Select cancel so that a message is not sent to Areafix.
  194.  
  195. Now if I wanted to attach to the Spot echo:
  196.  
  197. 1) Enter my Netmail area
  198. 2) Select AreaFixMan from the menu.
  199. 3) Select 'Attach' from the requester.
  200. 4) Enter the Spot echo and hit RETURN.
  201. 5) Hit return on the next blank requester to come around.
  202. 6) Select 'Okay'.
  203.  
  204. And I wanted an arealist:
  205.  
  206. 7) Select 'Yes' to requester.
  207.  
  208. The message would then be the last in the area.  If you want to
  209. cancel it, just delete the message.
  210.  
  211. Or, if I wanted to abort before stage 6.
  212.  
  213. 6) Select 'Cancel' from requester.
  214.  
  215. o The areafix created will be placed into the current area.
  216.  
  217. NOTE FOR MULTI-BOSSING USERS
  218. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  219. AreaFixMan is intelligent enough to differentiate between multiple
  220. netmail areas.  It will record the name of the area (it's REAL name)
  221. when you enter the boss' address and your password.  Whenever you use
  222. AreaFixMan in that area, the appropriate details will be recalled each
  223. time...good init?
  224.  
  225. UPGRADING
  226. ¯¯¯¯¯¯¯¯¯
  227. Upgrading from versions prior to 2.6, it is necessary to delete
  228. the config file and start from scratch...sorry!
  229.   From 2.6, no modifications are necessary as I've now discovered
  230. the benefits of future compatible config files although manual
  231. modifactions are needed to take advantage of new features.
  232.   To use 'announcement' on the 2.6 style config (you can tell
  233. this by viewing the config file and looking for the 'format 2.6'
  234. line,) you must edit the config file using an editor such as
  235. Commodore's Ed.  To activate announcement, simply type 'Announce'
  236. after the last line of each area's config which is the comment
  237. line (appears as 'Options' if you did not select a comment).
  238. Please leave a blank line after each area, including the last
  239. for example:
  240.  
  241. -- start
  242. FORMAT 2.6
  243. NET_2_254_149_3
  244. 2:254/149
  245. password
  246. Areafix
  247. Port of Call FIDONET
  248. Announce
  249.  
  250. -- end
  251.  
  252. To disable 'Announcement' put 'No Announce'.  Although ommiting
  253. this will do the same, it is advised you add it in as it will
  254. make future upgrading much easier.
  255.  
  256. o If this all seems to complicated then simply delete your
  257. config and start again from scratch, you will then be asked
  258. whether you would like announcement.
  259.  
  260. Future Enhancements __________________________________________________
  261.  
  262. o None that I can think of at the mo :-)
  263.  
  264. Disclaimer ___________________________________________________________
  265.  
  266. o I am not responsible to any damage caused through the use or misuse
  267. of this product and so it must only be used at your own risk.  All
  268. efforts have been made to ensure the stability of the program but
  269. this does not mean it is 100% safe.  Please backup any important data
  270. that could be damaged through the use of this software until you are
  271. sure that it is stable...Amen.
  272.  
  273. Donations/Comments ___________________________________________________
  274.  
  275. Any comments or donations can be sent to:
  276.  
  277.  PSR Software
  278.  Paul Ruane
  279.  26 Birdwood Close,
  280.  Selsdon, Surrey.
  281.  CR2 8QG.
  282.  
  283. I may also be contacted at the following addresses as Paul Ruane:
  284.  
  285.  Fidonet_____
  286.  2:252/149.3
  287.  2:253/516.12
  288.  
  289.  Amiganet____
  290.  39:135/14.3
  291.  39:135/13.12
  292.  
  293. _________________________________________________________________NULL_
  294.