home *** CD-ROM | disk | FTP | other *** search
/ Kosovo Orphans' Appeal Charity CD / KosovoOrphansAppeal.iso / internet / software / _antutils / _help < prev    next >
Encoding:
Text File  |  1998-09-15  |  11.4 KB  |  251 lines
  1. !Help file for !AntUtils v1.14 (15th Sep 1998)
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Please read (or at least scan through) all these instructions because I may
  5. have added some new features since the last version - namely Image indexing.
  6.  
  7.  
  8. Written by Paul Vigay, Jan 1997. This program is freeware, on the condition
  9. that it is copied in it's entirety without any files being changed.
  10. However, any donations will be gratefully accepted and will help inspire me
  11. to do further development and support the Acorn software market.
  12. A fiver would be nice, to cover some of the electricity used whilst coding
  13. and to buy more packets of tea, for all those late nights.
  14. The copyright remains with the author at all times.
  15.  
  16. Purpose
  17. ~~~~~~~
  18. To add various utilities to the Ant Internet Suite. Firstly, I wanted a way
  19. to automatically check mail every so often whilst I'm online surfing the
  20. world wide web. Other than Ant's suggestion of setting up a repeating task
  21. alarm in !Alarm, there doesn't seem to be an easy way of fetching mail
  22. automatically, and only if the Ant Suite is online (!Alarm doesn't like it if
  23. !InetSuite is not running)
  24. I also wanted a way of adding a random 'fortune cookie' or 'quote' onto the
  25. end of signature lines.
  26. AntUtils performs both of these tasks with each having it's own configurable
  27. time delay.
  28. Over time, I have also added a number of other features, described below.
  29.  
  30. Use/Choices
  31. ~~~~~~~~~~~
  32. To open the choices/configuration window, simply select 'Choices...' from the
  33. icon bar menu. This will open the choices window.
  34. To change a value simply enter a new value. If you want the feature turned
  35. on, simply toggle the icons on the left.
  36. Clicking on 'Save' will permanently (until the next time you click on 'Save')
  37. save the choices back to disc. OK will simply change them for this session
  38. only.
  39.  
  40. 'Check online mail and news' will allow you to automatically fetch either/or
  41. mail/news every so many minutes if you are online. This saves keep selecting
  42. the relevant menu option from the AntSuite icon menu.
  43.  
  44. 'Use random sig', if on, will automatically append a random cookie to your
  45. signature file. The master signatures are stored within AntUtils.Files.Users
  46. and the relevant username directory.
  47.  
  48. 'Auto status', if on, will automatically open the status window when you go
  49. online and then close it again when you disconnect.
  50.  
  51. 'Quit with InetSuite' will make !AntUtils quit automatically when you quit
  52. !InetSuite.
  53.  
  54. 'Lan connection' tells AntUtils to think it is permanently online, for people
  55. who use AntUtils via a local area network.
  56.  
  57. 'Multi-users' allows AntUtils to keep an eye on multiple user accounts and to
  58. automatically update phone logs, hotlists, signatures etc for more than one
  59. user.
  60.  
  61. 'News reader' allows you to tell AntUtils whether you are using Marcel or
  62. Jon Duddington's Pluto newsreader. This ensures that AntUtils knows where the
  63. relevant files and signatures are stored etc.
  64.  
  65. Clicking on Paths.... opens a small window which allows you to set the file
  66. paths for both Marcel and Pluto. This allows AntUtils to be run even if
  67. other applications have not been 'seen' yet. This allows you to install
  68. AntUtils as part of a !Boot sequence before the AntSuite has been loaded.
  69. To set the filepaths, simply locate your copy of !InetSuite and drag into the
  70. InetSuite icon in the path window.
  71. If you are using !Pluto, do the same to Pluto (but into the 'Pluto' icon).
  72. Remember to save the choices if you wish to keep these filepaths.
  73.  
  74. 'Auto Debatch' will only be available if you have selected Pluto as your
  75. preferred newsreader. If then toggled to 'on', AntUtils will tell Pluto to
  76. debatch new email messages one minute after the online newsfetch. eg. If your
  77. mail fetch is set to five minutes, and debatch is on, then AntUtils will tell
  78. Pluto to debatch email messages after six minutes. Hopefully one minute after
  79. fetching mail will be enough, but advanced users can edit the AntUtils messages
  80. file to allow longer times.
  81. News debatches will occur in the same fashion, but two minutes after the news
  82. fetch command. (Again, advanced users may edit the messages file)
  83.  
  84. 'Log cron events' will store each cron event in a log file, so that if you
  85. leave AntUtils to run automatic scripts you can come back later to check if
  86. the various commands have executed successfully.
  87.  
  88. 'Quick mail send' will tell AntUtils to check the Ant outgoing mail queue every
  89. five seconds (editable within the AntUtils.Resources.Messages file) for any
  90. mail messages waiting to be sent. If there are any, AntUtils will instruct the
  91. Ant Suite to send them immediately rather than wait until the next mail check.
  92. This option actually overrides the 'Check online mail' option because it will
  93. still activate even if the auto mail timer is turned off.
  94.  
  95. 'Check RMA' allows AntUtils to ensure that a minimum amount of RMA space is
  96. always available, hence fixing the fabled DLL crashing that the Ant Suite
  97. sometimes suffers from. The actual value of RMA space is defined within the
  98. AntUtils.Resources.Messages file and it's default value is 128k.
  99.  
  100. 'Cancel' will restore the settings to the previously saved ones.
  101.  
  102. 'Save' will save the settings for future use.
  103.  
  104. 'OK' will ok the settings for this session only, but next time you load
  105. AntUtils, the settings will be their original values.
  106.  
  107. Status Window
  108. ~~~~~~~~~~~~~
  109. A status window can be opened by selecting 'Status' from the icon bar menu or
  110. just clicking SELECT on the AntUtils icon.
  111. This simply opens a small window giving you the current modem/INetSuite
  112. status along with the time delay until the next mail check or signature
  113. change.
  114.  
  115. Auxillary Applications
  116. ~~~~~~~~~~~~~~~~~~~~~~
  117. If you click Adjust over the icon bar icon, AntUtils will open an auxillary
  118. utilities window. This operates very much like a mini pinboard and allows
  119. you to drag up to 8 applications into it, so you can launch them by double-
  120. clicking on the one you want. Apps are automatically saved within AntUtils
  121. so they are available next time you load AntUtils.
  122.  
  123. LAN connection
  124. ~~~~~~~~~~~~~~
  125. If you use InetSuite over a Local Area Network (LAN) you can toggle the LAN
  126. option on. This will tell !AntUtils that you have a permanent connection and
  127. will ignore the automatic on/offline detection.
  128.  
  129. Multi-users
  130. ~~~~~~~~~~~
  131. v1.03 and above of AntUtils will automatically provide some multi-user support
  132. for more than one user wanting to have settings within !InetSuite - for example
  133. multiple Fresco Hotlist files and call logging files.
  134. Simply select the user you require from the 'Users' menu and !AntUtils will
  135. manage the individual files for you. This allows different people using the
  136. same copy of !InetSuite to have their own hotlists and telephone logs. This 
  137. feature was added after noticing various requests for this on the AntChat
  138. mailing list.
  139. When you quit !AntUtils, the original files will be restored (ie. the files
  140. active when !AntUtils was loaded in the first place).
  141.  
  142. N.B. Please let me know of any bugs in this code, as obviously there are
  143. numerous different combinations of files. Please don't blame me if your hotlist
  144. file(s) get lost or corrupted. Although I've tested it as thoroughly as
  145. possible, it is still possible that certain combinations may confuse AntUtils.
  146.  
  147. Image Index
  148. ~~~~~~~~~~~
  149. * New feature added at v1.11 *
  150.  
  151. From the main menu, click on 'Index...' to open a control window containing
  152. a number of options.
  153. This feature will automatically create an HTML page containing a table of
  154. handy thumbnail images for any directory containing image (Sprite, JPEG, GIF
  155. or PNG - ie. formats understood by Fresco) files.
  156. Drag the HTML icon to the relevant directory to create the file.
  157. The various options are (I hope) self explanatory....
  158.  
  159. If you drag a directory to the Image Indexing window it will set the 
  160. destination directory of the images, if different to the location you wish
  161. to store the index and background image in.
  162. If you wish to create the index file in the same directory as the images,
  163. you MUST ensure that the 'Images' icon is blank.
  164. To set an image directory, you can either drag a directory or drag an
  165. individual file to the indexing window. If you drag an individual file, it
  166. will assume you wish to index the parent directory - ie. the directory that
  167. the file is in.
  168. N.B. AntUtils is fairly intelligent in that it will convert filenames into
  169. a format suitable for web browsing, if images are in a different location to
  170. where you want to save the index file - and also truncate filenames if it
  171. detects that the image directory is a sub-directory of where you are saving
  172. the index file.
  173.  
  174. Max columns decides how many thumbnails go across the page.
  175.  
  176. Max width is the width of each thumbnail image (100 pixels is about right)
  177.  
  178. Cell spacing is the distance between each cell in the table.
  179.  
  180. Use background, if on, will copy the image called 'background' inside
  181. !AntUtils.Resources into the destination directory to use as a background
  182. image. This can be any image type that Fresco recognises (filetypes above!)
  183.  
  184. Add HREFs will automatically add a link from each thumbnail image to the
  185. full size image.
  186.  
  187. Add filenames will also include the filenames underneath each thumbnail.
  188.  
  189. Advanced users may edit the default values for these parameters inside the
  190. !AntUtils.Resources.Messages file. Toggle options should be ON or OFF.
  191. You can also set the text of the title text (or have none) and set whether
  192. AntUtils will add a 'created at time' to the index.
  193.  
  194. CRON table
  195. ~~~~~~~~~~
  196. From v1.03 onwards !AntUtils can execute various commands at preset times of
  197. the day (assuming !AntUtils is loaded). Full instructions are provided within
  198. the 'cron' file inside !AntUtils.Files.
  199.  
  200. You can execute the next command immediately if you like, by double-clicking
  201. on the "Next Cron" icon in the status window.
  202.  
  203. N.B. Again, please let me know if there are any bugs you find.
  204.  
  205. Advanced Features
  206. ~~~~~~~~~~~~~~~~~
  207. Advanced users can configure whether or not AntUtils appears as an icon on the
  208. icon bar. Load AntUtils !Run file into your favourite editor and insert the 
  209. parameter -noicon immediately after the !RunImage in the last line. Leave a 
  210. space either side. ie, so it looks like
  211.  
  212.                 Run <AntUtils$Path>.!RunImage -noicon %*0
  213.  
  214. The default is to display an icon. ie.
  215.  
  216.                 Run <AntUtils$Path>.!RunImage %*0
  217.  
  218. Once AntUtils is loaded you can toggle the status (ie to make it reappear) by
  219. pressing SHIFT CTRL A U (ie. simultaneously hold down SHIFT, CTRL, A and U)
  220.  
  221. N.B. For the really advanced, the A and the U can be reconfigured by editing the
  222. hotlist1 and hotlist2 lines in the !AntUtils.Resources.Messages file. They are
  223. the INKEY- values as shown in the BBC Basic Guide.
  224.  
  225.  
  226. Future additions
  227. ~~~~~~~~~~~~~~~~
  228. I'm open to suggestions really. If you want extra features added please let
  229. me know. I want AntUtils to provide all the various little utilities you may
  230. need in a single application. Feel free to comment!
  231.  
  232. Contacting me
  233. ~~~~~~~~~~~~~
  234. You can contact me in several ways:-
  235. 1. Email me at pvigay@cix.compulink.co.uk
  236. 2. Go my Acorn Shareware page on the internet at http://www.interalpha.net/customer/pvigay/shareware.html
  237. 3. Dial into my BBS (24hr, 8N1) on 01705 871531
  238. 4. Write to me at 104 Manners Road, Southsea, Hampshire, PO4 0BG
  239. 5. or voice-phone me on 01705 871530 (0956 135633 One2One mobile, hence fairly cheap!)
  240.  
  241.  
  242. ⌐1997 Paul Vigay
  243.  
  244.  
  245. List of files in !AntUtils.Files (ie. alterable by the user)
  246. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  247. /signature    Original signature file. This is the base signature to which
  248.                 quotes get appended to.
  249. quotes        Random quote file. Add your own quotes here, each seperated
  250.         by a single zero (ASCII 0) code.
  251.