home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 29 / amigaformatcd29.iso / -readerstuff- / andrew_edmonds / docs / unit_readme < prev    next >
Encoding:
Text File  |  1998-05-28  |  9.8 KB  |  315 lines
  1.               -------------------------------------------------- 
  2.              |                                                  |
  3.              |    UNIT v2.4 - Ultimate New(ish) Internet Tool   |
  4.              |                                                  |
  5.              |         © Copyright 1998 Andrew Edmonds          |
  6.              |                                                  |
  7.              |                                                  |
  8.              |     UNIT was written using Cando version 2.5     | 
  9.              |                                                  |
  10.              |                                                  |     
  11.               --------------------------------------------------  
  12.  
  13.  
  14. CONTENTS:
  15.  
  16.  1. Introduction
  17.  2. Legal Information
  18.  3. Requirements
  19.  4. Features of UNIT
  20.  5. Usage
  21.         
  22.           5.1. Main UNIT Window
  23.           5.2. Prefs Window
  24.           5.3. Logfile Viewer
  25.           5.4. Current information
  26.           5.5. Statistics From Logfile
  27.           5.6. Window Control (Show/Hide, Snapshot etc.)
  28.             
  29.  6. Arexx Port + usage with AmiTCP and Miami
  30.  7. Acknowledgements
  31.  8. Contacts
  32.  
  33.  
  34. 1. INTRODUCTION:
  35.  
  36. UNIT 2 should not be confused with version 1.  They are very different
  37. programs.  UNIT 2 is an internet coster and Internet application 
  38. loader.  The "file viewing" part of version 1 has been dropped.  UNIT 
  39. tries, and in my opinion succeeds in not only being the best coster 
  40. in terms of features, but it also actually looks good!  
  41.  
  42. UNIT 2 has been in development for about 6-7 months and as a result it
  43. should be a stable, complete program.
  44.  
  45. This program uses the excellent Dopus icons and uses a classic MWB 
  46. look.
  47.  
  48.  
  49. 2. LEGAL INFORMATION:
  50.  
  51.  
  52. IMPORTANT!!  -  You should read this!
  53.  
  54.  
  55. THE AUTHOR OF UNIT (ANDREW EDMONDS) CANNOT BE HELD RESPONSIBLE FOR 
  56. ANY LOSS OF DATA OR DAMAGE OCCURED WHILE USING THIS PROGRAM.  USE 
  57. THIS PROGRAM AT YOUR OWN RISK.  THIS PROGRAM IS FREEWARE, HOWEVER 
  58. THE UNIT FILES ARE COPYRIGHTED BY ANDREW EDMONDS, ANY ALTERATIONS TO 
  59. THIS PROGRAM ARE A VIOLATION OF THIS COPYRIGHT.  THE PROGRAM MAY BE 
  60. DISTRIBUTED FREELY PROVIDING THE CHARGE FOR THE PROGRAM ONLY COVERS 
  61. POSTAGE AND COSTS.  PERMISSION IS HEREBY GRANTED FOR THIS PROGRAM TO 
  62. BE PUT ONTO AMINET CD'S.  OTHER PEOPLE INTERESTED SHOULD GET IN TOUCH 
  63. WITH THE AUTHOR. (EMAIL ADDRESS AT BOTTOM OF DOCUMENT). 
  64.  
  65. THE UNIT PROGRAM MUST BE DISTRIBUTED INCLUDING ALL THE FILES.
  66.  
  67.  
  68. *** THE PLAY16 AND WBRUN UTILITIES ARE COPYRIGHTED BY THEIR RESPECTED 
  69. *** AUTHORS.  USE THESE UTILITIES AT YOUR OWN RISK AS WELL.  SEE 
  70. *** THEIR DOCUMENTATION FOR MORE INFORMATION.
  71.  
  72.  
  73. 3. REQUIREMENTS:
  74.  
  75. * Nice MWB screen, although it SHOULD work with newicons as long as 
  76.   the first 8 colours in the palette are MWB ones.
  77.  
  78. * Ideally this program should be used with Miami, although you can 
  79.   use it with AmiTCP.
  80.  
  81. * WBRun by The Software Distillery (supplied)
  82.  
  83. * Play16 (also supplied)
  84.  
  85. * Possibly WB 2+ (not confirmed)
  86.  
  87.  
  88. 4. FEATURES:
  89.  
  90. * Costing with accurate, up-to date pricing which can be altered.
  91.  
  92. * Can control Miami, and had a pseudo arexx port.
  93.  
  94. * Keeps a logfile, and every month the total cost of calls for that 
  95.   month is totalled up.  VAT is also included.
  96.  
  97. * Great Font Sensitive MWB GUI which uses no external programs like 
  98.   MUI!.
  99.  
  100. * Can be set to send a HTML file to your browser  every x amount of 
  101.   minutes telling you how long you have been online!
  102.  
  103. * In built statistical program which can draw graphs of your logfile.
  104.  
  105. * UNIT can be set to play a sound every x amount of minutes online.
  106.  
  107. * Currency and call rates can be set.
  108.  
  109. * Can launch all your internet utilities.
  110.  
  111. * Window with snapshot abilities and it can be hidden, at start or 
  112.   after loading.
  113.  
  114. * Stable, reliable program.
  115.  
  116. * Low CPU usage in standard operation.
  117.  
  118. * Can be set to play a sound sample when you go on and offline.
  119.   Also can be set to play a "tut" sound when you click on any button
  120.   within UNIT.
  121.  
  122.  
  123.  
  124. 5. USAGE:
  125.  
  126.  
  127. 5.1: Main Screen 
  128.  
  129.  
  130. The main window of UNIT shows a row of six icons.  These represent the
  131. various types of internet programs used.  They represent (from left to
  132. right):
  133.  
  134. TCP/IP Stack (eg Miami/AmiTCP)
  135. Web Browser
  136. Email Software
  137. FTP Software
  138. IRC/Chat Software
  139. Newsgroup Software
  140.  
  141. The programs and their paths are set using the prefs screen (see later
  142. section).
  143.  
  144. Also on the main screen is the current amount of time you have been 
  145. online in the format of HH:MM:SS (or "Offline").  Next to it is the 
  146. Cost of your current call.  Below these are the main control buttons 
  147. of UNIT.  Online and Offline should be clicked when you wish to start 
  148. and stop the timing process.  The Quit button controls Miami (NOT 
  149. Unit).  An option exists where by you can configure UNIT to 
  150. physically go online when you click on Online when using Miami.
  151.  
  152.  
  153. 5.2: Prefs Screen
  154.  
  155.  
  156. The prefs screen is accessible in the Prefs/Edit menu in the main UNIT
  157. window.  Here is a description of the usages of the options.
  158.  
  159. Along the right hand side of the window are the six buttons which are 
  160. used to set the software you wish to be loaded when clicking on the 
  161. same button on the main window.  Clicking on each in turn enables you 
  162. to set the executable files.
  163.  
  164. The option to control Miami should be set to Yes if you wish Miami to 
  165. go online if you click on Online in the UNIT program.  If you use 
  166. AmiTCP then see the section in this document on UNITs pseudo Arrex 
  167. funtions.
  168.  
  169. Many people on BT choose their ISP as a Friends and Family no. if this
  170. is the case for you selecting yes will make the cost of the calls 
  171. decrease by 10% as required.
  172.  
  173. The Confirm option simply gives you the chance to confirm 
  174. Online/Offline actions (so you don't accidentally go offline).
  175.  
  176. The main UNIT window can be hidden when loaded, i.e the main window 
  177. doesn't pop up when the program is loaded; but it can maximised later.
  178. The option to hide at start should be set to yes if you wish this to 
  179. be the case.
  180.  
  181. UNIT has the capability to send a HTML file to your browser every x 
  182. amount of minutes (set be the how often? field).  If you wish a HTML 
  183. file to be sent to your browser telling you how long you have been 
  184. online for then set this to yes.  You should also set the browser to 
  185. the correct one for your system IB (IBrowse), or Voy (Voyager).
  186.  
  187. The time notification prefs can be set to play a sample every x 
  188. amount of minutes online.  The how often? option should be set to 
  189. the number of minutes you want to pass between each warning.  The 
  190. required Sound Sample should be set using the Sample button.  To 
  191. test and hear the currently selected sample click on the waveform 
  192. next to the Sample button.
  193.  
  194. The bottom section of the prefs is concerned with rates for UNIT.  
  195. The default setting should be fine for most people.  The currency 
  196. option should be set with your country's currency (eg. £/$/DM etc)
  197.  
  198.  
  199. 5.3: In-Built Logfile
  200.  
  201.  
  202. UNIT has an in-built logfile which covers information about the calls 
  203. you have made each month.  The logfile can be viewed by selecting the 
  204. Logfile.. View option in the Information menu in the main UNIT window.
  205.  
  206. You also have the option to clear and print the logfile..
  207.  
  208.  
  209. 5.4: Current Information
  210.  
  211.  
  212. This window is accessible by selecting the Current Information option 
  213. in the Information menu.
  214.  
  215. The window will give you information on the current cost per min. of 
  216. any call and other information connected with calls at the time.
  217.  
  218.  
  219. 5.5: Statistics From Logfile
  220.  
  221.  
  222. Various statistics can be shown from the current logfile by selecting 
  223. the Logfile Stats option in the Information menu.
  224.  
  225. There is also an option to draw a graph from the logfile.  This option
  226. can be found in the Information..Logfile menu.
  227.  
  228.  
  229.  
  230. 5.6: Window Control Of UNIT
  231.  
  232.  
  233. The UNIT window can be hidden using the RAmiga H shortcut (or select 
  234. in the menu).  While hidden UNIT will still continue to calculate the 
  235. call cost.  It can be maximised/shown again by using the RAmiga S 
  236. shortcut (or select option in the menu).
  237.  
  238. The main window (and hidden window) may be snapshotted so they appear 
  239. in the same position each time the unit program is executed.  Note 
  240. that you should use the snapshot function in UNIT's window menu (not 
  241. the WB snapshot).
  242.  
  243.  
  244.  
  245. 6. AREXX PORT:
  246.  
  247.  
  248. UNIT does not have an arexx port, but it has arexx like features.  
  249.  
  250. By typing in (UNITPath)Online in a shell menu it will send UNIT 
  251. Online, and (UNITPath)Offline does the reverse.
  252.  
  253. The UNITPath text should be replaced with the path that the Online 
  254. executable is found (where you installed UNIT.)
  255.  
  256.         e.g   Work:Internet/UNIT/Online
  257.          or   Work:Internet/UNIT/Offline              
  258.  
  259. AmiTCP has the capability of making a script which is executed when 
  260. you go on/off line.  By setting this script up in a certain way you 
  261. can cause UNIT to start and stop costing at the correct time, thus 
  262. making the Online/Offline buttons of UNIT redundant.
  263.  
  264. In you AmiTCP online script place the line:
  265.  
  266.  
  267. (UNITPath)Online     e.g:  Work:UNIT/Online
  268.                       or   Work:Internet/UNIT/Online  
  269.  
  270.  
  271. Change the Offline script to include:
  272.  
  273.  
  274. (UNITPath)Offline    e.g:  Work:UNIT/Offline
  275.                       or   Work:Internet/UNIT/Offline
  276.  
  277.  
  278. Now when you go Online using AmiTCP UNIT should start costing and 
  279. stop when you go Offline.
  280.  
  281. The same thing can be done to Miami using the same commands,  it can 
  282. be set to start UNIT timing when you go online with UNIT.  
  283.  
  284.  
  285. 7. ACKNOWLEDGEMENTS:
  286.  
  287.  
  288. The Software    - For their WBRun program. 
  289. Distilery
  290.  
  291. Andrew Jones    - For allowing me to use his email address for email 
  292.                   meesages connected with UNIT (I'm not on the 
  293.                   internet!)
  294. Leo Davidson 
  295. & Trevor Morris - For allowing me to use their wonderful MWB images.
  296.  
  297. Tony Leach      - Beta testing and suggestions.
  298.  
  299. Laurence James  - Extra ideas and assistance.
  300.  
  301.       
  302. 8. CONTACTS:
  303.  
  304.  
  305. To get in touch with me with bug reports, suggestions etc. then 
  306. Email me through my friend Andrew Jones at the following Email 
  307. address:
  308.  
  309. argonauts@sea.abel.co.uk 
  310.  
  311.  
  312.  
  313.        ---- UNIT DOCUMENTATION BY ANDREW EDMONDS rev. 1 ----
  314.  
  315.