home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / pmt117.zip / README.TXT < prev   
Text File  |  1997-04-21  |  12KB  |  257 lines
  1. ********************************************************
  2. *                                                     ***
  3. *   This is readme.txt for PM Timer version: 1.17     ***
  4. *                                                     ***
  5. *********************************************************
  6.  ********************************************************
  7.  
  8.  
  9. What is it?
  10. ===========
  11. PM Timer/2 is an online phone costs calculation program for OS/2 Presentation
  12. Manager. It gets rid of the hassle of having to use a different logfile for
  13. every communications program you use, not to mention the programs that don't
  14. even keep a logfile (think about Dial Other Internet Providers in the OS/2 Warp
  15. bonuspak).
  16.  
  17. PM Timer - when used in the right manner - logs all your outgoing calls in one
  18. single logfile and calculates the phone costs made in a specified period of
  19. time on your demand.
  20.  
  21. PM Timer will monitor the serial port to which your modem is connected and
  22. detect any connections you make with your modem or ISDN-card. (The latter only
  23. if you access your ISDN-card through a virtual comport provided by e.g. Cfos/2)
  24.  
  25. Furthermore, if desired you can run PM Timer unattended from batchfiles using
  26. commandline parameters.
  27.  
  28. And, with PM Timer running you'll always keep track of your online (surfing)
  29. time, even if the PM Timer window is invisible. PM Timer places a small clock
  30. that displays the online time and costs for that session in the currently
  31. active Presentation Manager window's titlebar.
  32.  
  33.  
  34. Installation
  35. ============
  36. I recommend you to install PM Timer in its own directory. Installation is
  37. simply a matter of copying all the files from the PM Timer archive to an
  38. empty directory. In case you want to be able to start the program from other
  39. directories you have to make sure that the file IOPL.DLL is located in a
  40. directory in your LIBPATH statement in config.sys. Also make sure you have
  41. IOPL=YES in your config.sys.
  42.  
  43. NOTE: If you install PM Timer into the same directory as a previous version,
  44.       it may be nescesary to delete the pmtimer.ini if it exists.
  45.       Also, if for some reason the dialogs and windows seem out of proportion,
  46.       use an ini-editor to delete a possible PMTIMER application entry from a
  47.       previous version in os2.ini.
  48.  
  49.  
  50. Usage
  51. =====
  52. The main idea is to start PM Timer together with your communications program
  53. from a batchfile (.CMD). That is the way I use it myself.
  54.  
  55. You can also put PM Timer in your startup folder and let it startup minimized
  56. with the /h commandline parameter. Note however, that PM Timer at the moment is
  57. not able to tell the difference between an incoming and outgoing call. So this
  58. option is out of the question if you run a BBS, PM Timer would be logging your
  59. incoming as well as your outgoing calls.
  60. Maybe it is an idea to setup events in your mailer software that startup
  61. PM Timer before your mailer is going to make it's outbound calls and shutdown
  62. PM Timer afterwards.
  63.  
  64. Personally I prefer the first method, because that way you can setup different
  65. startup parameters (i.e. what distance zone to use, hide/not hide) for the
  66. different communication programs you use.
  67.  
  68. If you use the first method, simply create a batchfile in your communication
  69. program's directory that looks like this:
  70.  
  71. @ECHO OFF
  72. START X:\PATH\PMTIMER [/Zx /H /W /INI=filename.ini]
  73. COMPROG.EXE
  74. X:\PATH\PMTIMER /Q
  75.  
  76. Where: * X:\PATH\ is the drive and directory where you keep PM Timer files.
  77.  
  78.        * COMPROG.EXE is the executable file which starts your communication
  79.          program.
  80.  
  81.        * /Zx commandline parameter (optional)
  82.          If specified, PM Timer will startup and select Zone x (x = 0..7)
  83.          settings for costs-calculation. So it's basically an alternative for
  84.          selecting the zone via the spinbutton in the main window.
  85.          Zone names are configurable in the program settings, but the value for
  86.          x is proportional to the costs-pages in the settings dialog.
  87.          (i.e. /Z0 indicates costs-page 1, /Z1 indicates costs-page 2 etc.)
  88.  
  89.        * /H commandline parameter (optional)
  90.          If specified, PM Timer will startup invisible. You can make it visible
  91.          by doubleclicking its entry in the window list.
  92.  
  93.        * /Q commandline parameter (optional)
  94.          Well, it's kind of optional. In the example above it is required.
  95.          If PM Timer is started with this option specified it will try and
  96.          find an already running copy of itself in memory and correctly
  97.          terminate it. (Same effect as choosing Close from the system menu
  98.          or hitting ALT-F4.)
  99.  
  100.        * /W commandline parameter (optional)
  101.          If specified, PM Timer will not display the warning dialog if you
  102.          attempt to close the program while it's still timing. (The use of
  103.          this parameter is only recommended if you run PM Timer unattended
  104.          from a batchfile.)
  105.  
  106.        * /INI=filename.ini commandline parameter (optional)
  107.          If specified, PM Timer will use the file "filename.ini" instead of the
  108.          default pmtimer.ini to store and retrieve it's configuration.
  109.          You should only specify a filename, no PATH. The file will be created
  110.          (if it doesn't exist) in the PM Timer directory.
  111.  
  112.  
  113. Next I will discuss some of the PM Timer menu options you'll find in the main
  114. window's system menu.
  115.  
  116.  
  117. Settings...
  118. ===========
  119. This will bring up the settings notebook which is pretty much self explanatory
  120. and has 'fly-over-help' all over the place.
  121.  
  122. Make sure that - on the hardware settings page - you select the comport where
  123. your modem can be found and specify an accurate value in the seconds-to-carrier
  124. field. (That's the number of seconds between the time you actually connect and
  125. the time that the program detects a carrier.)
  126.  
  127. Also on the hardware settings page, you can tell PMTimer to access the comport
  128. either using driver access (SIO.SYS/COM.SYS) or direct hardware access. If you
  129. choose the latter, make sure you have the line IOPL=YES in config.sys.
  130. The disadvantage of driver access is that (with COM.SYS) DOS/WIN-OS2 sessions
  131. have exclusive access to the port, so PMTimer won't be able to access the port.
  132. Also, there are some OS/2 apps that won't hang up if PMTimer is monitoring
  133. using driver access. For those reasons I recommend using direct hardware
  134. access.
  135. Note however, if you have virtual comports that you want to monitor ( as
  136. provided by Cfos/2 for example) you _have_ to use driver access.
  137.  
  138. The general options speak for them selves I think.
  139. Same goes for the costs. There are 8 cost pages which cover eight different
  140. distance zones. For every distance zone you can have ten different time periods
  141. with different costs.
  142.  
  143. Furthermore I want to point out that on the general options page you'll find
  144. two buttons for Importing or Exporting ZOC .FEE (*) files. On import only the
  145. TIME and FEE lines are read. Only the first 8 (non empty) FEE lines will be used
  146. because PMTimer can't handle more at the moment. (Normally this should be
  147. sufficient though.)
  148.  
  149. FEE files exported by PMTimer can be read by ZOC and (of course) by PMTimer.
  150. On export, the Charge/second checkbox-state won't be preserved.
  151. The costs/time-unit however will be converted to costs/second if you have
  152. checked the option to charge per second.
  153. So for example, 0.12 per 60 second with charge/second checked will be converted
  154. to 0.002 per 1 second. This will show up in the fee-file as 2/1@Tx since the
  155. fee-file format handles fees in cents.
  156.  
  157. In the archive you'll find some fee-files, if there is one for your country,
  158. import it and you don't have to bother about setting up the costs yourself.
  159. I would recommend to check the imported values though. I can't guarantee that
  160. all fees are up to date. (I can only speak for the Dutch fees, they are up
  161. to date.) If you have an updated fee-file (or a new one if there isn't one for
  162. your country) you're welcome to send it to me (see bottom of this document for
  163. my address) and I'll include it in the next distribution of PMTimer.
  164.  
  165.  
  166. Calculate...
  167. ============
  168. The calculation dialog is also very much self explanatory. Fill in a
  169. start  and end date for the period over which you want to calculate your phone
  170. costs. The Costs field will be update on the fly as you adjust the spinbuttons.
  171. The defaults for both from and to date fields is the current date unless you
  172. checked the "Save on exit" checkbox the last time you used the calculation
  173. dialog. "Save on exit" always remembers the last used From: date for
  174. calculation.
  175.  
  176. Calculation is done by reading values directly from the ASCII logfile created
  177. by PM Timer. So I would not advice you to manually edit that file, unless you
  178. really know what you're doing. Results could be unpredictable if the program
  179. finds stuff in the logfile that doesn't belong there.
  180.  
  181. Also in the calculation dialog you will find some statistics for the complete
  182. log-file and the currently selected period.
  183.  
  184. NOTE: The currency symbol in the costs field and the date fields are country
  185.       dependant. So if you don't see the costs displayed in your own currency
  186.       it's because you're COUNTRY= line in config.sys doesn't reflect the
  187.       country you live in.
  188.  
  189. Both Settings and Calculation dialog will accept and keep dropped fonts and
  190. colors provided you have checked "Use OS/2.INI" on the general option page.
  191.  
  192.  
  193. Log window
  194. ==========
  195. This is just there for your convenience. It displays the logfile in a separate
  196. scrollable window.
  197.  
  198.  
  199. Product information
  200. ===================
  201. Displays a dialog with some program info and how to contact me.
  202.  
  203.  
  204. Note about the timer-display
  205. ============================
  206. Sometimes it may seem as if the timer skips a second. This is normal behavior.
  207. PM Timer internally uses the hardware IRQ0 timer interrupt to keep track of your
  208. online time. This way the timer always runs independent of system load.
  209. However the timer-display *update* does run on a simple OS/2 internal timer and
  210. thus is dependent on system load.
  211. The reason that PM Timer does not simply take timestamps from the system clock,
  212. is that I (and maybe you and a lot of other people) use programs that synchro-
  213. nize your PC's systemtime with an Internet timeserver while online.
  214. With the current implementation of PM Timer, this doesn't effect timings at all.
  215.  
  216.  
  217. Please send any bug reports and/or suggestions
  218. to enhance the program to the author:
  219.  
  220.            Jeffrey Habets
  221. snailmail: Generaal Eisenhowerstraat 41
  222.            6224 XH Maastricht / Netherlands
  223. e-mail:    jeffh@xs4all.nl
  224. http:      www.xs4all.nl/~jeffh
  225. FidoNet:   2:284/312.3
  226.  
  227. Reported bugs will be fixed as soon as possible if necessary. I can't make any
  228. promises on implementing enhancements to the program though. I also have my
  229. final exams to think about this year.
  230.  
  231. At the moment this program is released as freeware. Despite that, I would like
  232. to hear from you if you intent on using PM Timer on a regular basis. (e-mail
  233. is fine, but I also would appreciate a nice postcard of your home town. And of
  234. course I am not exactly *forbidding* you to send me any money. ;-)
  235. That way I can keep track on the number of people that use PM Timer and in
  236. what countries they live. This will help me to decide on future releases for
  237. the program.
  238.  
  239.  
  240. Copyright and Warranty
  241. ======================
  242. PM Timer/2 and all files that come with it in the archive may only be spread in
  243. unmodified form with or without the author's permission. If you decide to spread
  244. the program on a certain media (say disk or CD) you are only allowed to charge
  245. minimal fees to cover expenses.
  246. In any other case the author's written permission is needed.
  247. PM Timer comes without any kind of warranty. The only thing I can guarantee is
  248. that the program uses harddisk space, RAM and CPU-time.
  249. The author assumes no responsibility for any damage or loss of data arising
  250. from the use or inability to use this program.
  251.  
  252.  
  253. * ZOC (Zap-O-Comm) and it's FEE file-format appears courtesy of EmTec.
  254.   The ZOC generated fee-files provided with this program are used with
  255.   permission from EmTec.
  256.  
  257.