home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / look101.zip / readme.txt < prev   
Text File  |  1997-12-07  |  8KB  |  231 lines
  1. ====================================================================
  2.  Lookout for OS/2 - Version 1.01
  3. ====================================================================
  4.  
  5.  
  6. Table of Contents:
  7.  
  8. 0. What's new in this version?
  9.  
  10. 1. What is Lookout for OS/2?
  11.  
  12. 2. How do I install it?
  13.  
  14. 3. How do I use it?
  15.  
  16. 4. How does it work?
  17.  
  18. 5. Where do I send bug reports & suggestions?
  19.  
  20. 6. Known bugs & what's planned?
  21.  
  22. 7. How do I register?
  23.  
  24. ====================================================================
  25.  
  26.  
  27. 0. What's new in this version?
  28.  
  29.  
  30. Version 1.01 - First bug-fix release.
  31.  
  32. Problem - Lookout crashes when watching more than 3 or 4 FTP sites
  33. Fixed - rewrote function that compares two FTP directory listings
  34.  
  35. Special thanks to Ludwig Fischer for finding this bug.
  36.  
  37. Problem - If program is exitted while sites are being checked,
  38. it may crash on the next run.
  39. Fixed - don't update file name until check is successfully completed.
  40.  
  41. Problem - Sites that hadn't been checked yet, or that didn't have
  42. a file to compare against, reported as changed.
  43. Fixed - report new sites as not changed.
  44.  
  45.  
  46. ====================================================================
  47.  
  48.  
  49. 1. What is Lookout for OS/2?
  50.  
  51. Lookout for OS/2 is a internet notifier.  It will watch Web, FTP and
  52. Gopher sites, and tell you if they have changed.  A "Lookout" is
  53. also known as a "bot", an "agent" or an "informant".  In this
  54. document, we refer to them as "Lookout"s.
  55.  
  56. ====================================================================
  57.  
  58.  
  59. 2. How do I install it?
  60.  
  61.  
  62. The file lko*.zip should unzip into 2 files, this read.me, and
  63. lookout.zip.  Unzip lookout.zip with the -d option into the
  64. directory where you want it to stay.  The -d option is needed to
  65. create the "cache" directory.
  66.  
  67. ====================================================================
  68.  
  69.  
  70. 3. How do I use it?
  71.  
  72.  
  73. Start by running lookout.exe.  Program settings are saved in lookout.ini,
  74. and information about the various sites is stored in lookout.dat.  There
  75. should be a lookout.dat included with this distribution.  It will start
  76. you off watching one site, the "Lookout for OS/2 Home Page".
  77.  
  78. The main window of Lookout contains a list box, where information
  79. about each Lookout is displayed and updated.  You can right-click
  80. on a Lookout's line to display a popup menu, with choices of actions
  81. to perform on that Lookout.  Here's a list of what you can do:
  82.  
  83.     Create - create a new Web, FTP or Gopher Lookout
  84.     Edit - change the settings and parameters for a Lookout
  85.     Delete - self-explanatory
  86.     Check - have the Lookout check right now if the site has been changed
  87.     Reset - change the Lookout's status to "Idle"
  88.     Start watching - if the selected Lookout is suspended, start watching it
  89.     Stop watching - stop checking the selected Lookout
  90.  
  91. If the selected Lookout watches an FTP site, you also get the choice:
  92.  
  93.     Details - if an FTP site has changed, this will display a
  94.     dialog that lists what files have been added, removed or changed.
  95.  
  96. To create a new Lookout, select "Lookout|New|Web", or "FTP" or "Gopher".
  97. Most of the fields on the Create & Edit dialogs are obvious.  Here are
  98. the not-so-obvious ones:
  99.  
  100.     Gopher:
  101.         Selection string - the selection string of the Gopher item
  102.         you want to watch.  If left blank, will default to a new-line,
  103.         which is the Gopher default.
  104.  
  105.     Web:
  106.         URL - the "Universal Resource Locator(?)".  Basically,
  107.         this is what you see in the URL field on a browser.
  108.         More... - displays another dialog, where you can enter words
  109.         and strings that the program will ignore when comparing two HTML
  110.         files to see if a site has changed.
  111.  
  112.     FTP:
  113.         Directory - defaults to "/".
  114.         More... - displays another dialog, where you can enter file names
  115.         and parts of file names that the program will ignore when checking
  116.         if an FTP site has changed.  "index" is a good one to add here.
  117.  
  118.  
  119. Select "Settings|Program settings..." to bring up the settings notebook.  Web, FTP
  120. and Gopher each have a notebook page where you can select and enter the client program
  121. used to "view" a Lookout.  Also, there is a field to format the command line of the
  122. client program.
  123.  
  124. For FTP Lookouts, place the following in the "FTP Client Parameters"
  125. field in the order your FTP client needs them:  %host %user %password %port %dir
  126.  
  127. Web Lookouts only recognize one parameter:  %URL
  128.  
  129. Gopher Lookouts recognize %host, %port and %selector
  130.  
  131. For example, if you want to use the IBM WebExplorer as your Web client, and you normally
  132. start it from the command line with the "-q -t 6" options, in the "Web Client Parameters"
  133. field, you would enter "%URI -q -t 6".
  134.  
  135. For another example, if you use VXFTP for your FTP client, you could enter the following
  136. command line in "FTP Client Parameters":  "%host %user %password %dir".
  137.  
  138. If a client program that you select is not in your PATH, you must enter the full path to
  139. the program in the "Client" entry field.
  140.  
  141.  
  142. ====================================================================
  143.  
  144.  
  145. 4.  How does it work?
  146.  
  147.  
  148. Each Lookout has a thread that does the checking.  Every 30 seconds, the main thread goes
  149. through the list of Lookouts, and sees if it's time for any of them to be checked.  If it
  150. is, that Lookout's thread is started, and it does the checking.
  151.  
  152. ====================================================================
  153.  
  154.  
  155. 5.  Where do I send bug reports & suggestions?
  156.  
  157.  
  158. Obviously, I need bug reports.  But, I am very interested in any ideas you have for improving
  159. the performance and usability of this program.  If you have any problems, suggestions or
  160. enhancements, please send them to:
  161.  
  162.     ckennedy@primenet.com
  163.  
  164. Also, use Lookout to watch the Lookout for OS/2 home page, at
  165.  
  166.     http://www.primenet.com/~ckennedy/software/lookout
  167.  
  168. This distribution contains a lookout.dat file with the information for this site.
  169.  
  170.  
  171. ====================================================================
  172.  
  173.  
  174. 6.  Known bugs & what's planned?
  175.  
  176.  
  177. If the program is interrupted/exitted while one of the Lookouts is in the "Checking"
  178. state, the next time you run the program, it may crash.  If you suffer a crash,
  179. delete the contents of the "cache" directory, then start the program again.
  180.  
  181.  
  182. What's not implemented yet?
  183.  
  184. *POSTPONED - Applying temporary overrides permanently, on the "Global Overrides" page of the settings notebook.
  185.  
  186.  
  187. What's planned?
  188.  
  189. Near-term ( before general availability )
  190. *SORTA DONE - fix the interrupt/cache bug
  191. *UNDOCUMENTED FEATURE! - add intelligence about the command line formats of different clients
  192.  
  193. *OOPS, PROBLEM, POSTPONED NOT DONE - add a toolbar
  194.  
  195. *POSTPONED - applying the overrides
  196. *POSTPONED - Re-package Visual Age C++ dll's to reduce size.
  197.  
  198.  
  199. Mid-term ( version 1.1? )
  200. - ability to kill off a "hung" socket
  201. - modularize the code
  202. - allow adding files to ignore list from the "Details" dialog
  203. - allow FTP'ing of files from the "Details" dialog
  204. - applying temporary overrides.
  205.  
  206. Long-term ( version 2.0 )
  207. - bring down entire web pages, for offline browsing
  208. - ability to watch more than one page/directory/selection at a site
  209. - use notebook as main user interface, with Lookout as one page
  210. - add pages for mail checker, ping, finger, webster
  211.  
  212.  
  213. ====================================================================
  214.  
  215.  
  216. 7.  How do I register?
  217.  
  218.  
  219. Please see the file "register.txt" included with this distribution.
  220.  
  221.  
  222. ====================================================================
  223.  
  224.  
  225. Chris Kennedy
  226. December 7, 1997
  227.  
  228. Frugal Software
  229. ckennedy@primenet.com
  230. http://www.primenet.com/~ckennedy/software/lookout
  231.