home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / lwpip11a.zip / lwpchart.HLP (.txt) < prev    next >
OS/2 Help File  |  1996-10-10  |  23KB  |  427 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Lynn's WorkPlace IP Thruput Chart ΓòÉΓòÉΓòÉ
  3.  
  4.                         Lynn's WorkPlace IP Thruput Chart
  5.  
  6.      What Is It? 
  7.      Disclaimer 
  8.      Installation 
  9.      Usage Hints 
  10.      Benefits Of Registration 
  11.      Registration Form 
  12.  
  13.  This book replaces the "readme" file traditionally included with shareware 
  14.  products.  It contains the previously listed sections as well as all of the 
  15.  help associated with the various windows of LWPChart.  Feel free to browse the 
  16.  pages at will or simply double click on Installation for a quick introduction 
  17.  to the installation process. 
  18.  
  19.  
  20. ΓòÉΓòÉΓòÉ 1.1. What Is It? ΓòÉΓòÉΓòÉ
  21.  
  22. LWPChart is a TCP/IP and CPU monitor utility providing throughput and error 
  23. indications in small, unobtrusive windows on your desktop.  If you've ever 
  24. wondered just what your Internet link was doing when things seem slow, this 
  25. could be what you're looking for. 
  26.  
  27. Each of the charts comprising LWPChart (see following list) has a similar 
  28. layout.  The title bar identifies each window.  The display in each client area 
  29. comprises a graph and a pair of numbers on the left hand side. The display is 
  30. updated every two seconds.  The width of the graph represents four minutes of 
  31. data (120 pixels at 2 seconds/pixel). 
  32.  
  33. The currently supported windows are: 
  34.  
  35.      Memory/Swap 
  36.      CPU/Swap 
  37.      IP Pkts 
  38.      IP Thru 
  39.      Tcp GvB 
  40.  
  41.  Various windows may, under certain circumstances, change either foreground or 
  42.  background colors.  The meanings of these changes are discussed in the 
  43.  description pages for the various windows. 
  44.  
  45.  Further information may be obtained by double-clicking on the client area of 
  46.  each window -- this will cause the appearance of the Max Values box reporting 
  47.  the scale of the graph window and the highest reported value in the graph 
  48.  along with the current Minimum, Maximum, and Average for the currently visible 
  49.  data. 
  50.  
  51.  Lynn's WorkPlace IP Chart is a shareware application. If you don't know what 
  52.  all that means, look it up elsewhere.  The fundamentals are that the software 
  53.  is yours to evaluate for a "reasonable" time (I estimate 2-4 weeks is 
  54.  "reasonable").  After your evaluation, you are expected to either remove the 
  55.  software and quit using it, or register it. 
  56.  
  57.  Why Register?  Well, the best reason is to compensate authors for work that 
  58.  you find useful and valuable.  But what's in it for you?  Double-click here to 
  59.  find out. 
  60.  
  61.  To register, send $10.00 (US) to: 
  62.  
  63.   Mr. Lynn W. Deffenbaugh
  64.   Homeside Software, Inc.
  65.   P.O. Box 100453
  66.   Palm Bay, FL  32910-0453
  67.   USA
  68.  
  69.  To get the latest version of LWPFTP, just check out the web page at 
  70.  http://www.teamos2.org/homeside/lwpchart. 
  71.  
  72.  
  73. ΓòÉΓòÉΓòÉ 1.2. Disclaimer ΓòÉΓòÉΓòÉ
  74.  
  75. LWPChart is delivered as-is.  While the author would appreciate problem 
  76. reports, there is no requirement or warranty for fixing supposed problems or 
  77. delivering such fixes if they are done. 
  78.  
  79. There is no warranty on LWPChart, express or implied, including any implied 
  80. warranty of merchantability and fitness for a particular purpose.  However, 
  81. some areas do not allow the exclusion of implied warranty, so the above 
  82. exclusion may not apply to you. 
  83.  
  84. The author (and any distributors) assume no liability for damages, direct or 
  85. consequential, which may result from using LWPChart, even if advised of the 
  86. possibility of such damages.  In addition, the author assumes no liability for 
  87. damages claimed by you based on a third-party claim. 
  88.  
  89.  
  90. ΓòÉΓòÉΓòÉ 1.3. Credits ΓòÉΓòÉΓòÉ
  91.  
  92. A very large Thank You is extended to my loyal Beta testers.  This especially 
  93. goes to the members of the Space Coast OS/2 User's Group for giving me the 
  94. encouragement to actually complete this utility and release it. 
  95.  
  96. Here's the full list of 1.0 testers. 
  97.  
  98.      Ron Couts 
  99.      Dan Fisher 
  100.      Sean Payne 
  101.      Trase Rowland 
  102.  
  103.  
  104. ΓòÉΓòÉΓòÉ 2. Installation ΓòÉΓòÉΓòÉ
  105.  
  106. To install LWPChart, simply copy the .EXE to a directory contained on your PATH 
  107. (like C:\OS2) and the .HLP to a directory contained in your HELP environment 
  108. variable (like C:\OS2\HELP).  To get LWPChart to auto-start each time your 
  109. system boots, either place a program object (or shadow of the .EXE) in your 
  110. Startup folder or add the line "start lwpchart" to your STARTUP.CMD file. 
  111.  
  112.  
  113. ΓòÉΓòÉΓòÉ 3. Registration Form ΓòÉΓòÉΓòÉ
  114.  
  115.  
  116. Please register ____ copies of LWPChart @ $10.00 (US) each.  Total  ___________
  117.  
  118. I have version _____ which I downloaded from __________________________________
  119.  
  120.  
  121. Name:    ______________________________________________________________________
  122.  
  123. Address: ______________________________________________________________________
  124.  
  125.          ______________________________________________________________________
  126.  
  127.          ______________________________________________________________________
  128.  
  129. Email:   ______________________________________________________________________
  130.  
  131. Phone:   ______________________________________________________________________
  132.  
  133.  
  134. Send my registration key via: ____ Email (preferred) or ____ Snail Mail
  135.  
  136. Mail this form (filled in, of course) along with a check (drawn on a US
  137. bank or an official bank draft), money order, or cash (I have a secure
  138. mailbox) for the total shown above (in US funds) to:
  139.  
  140. Mr. Lynn W. Deffenbaugh
  141. c/o Homeside Software, Inc.
  142. P.O. Box 100453
  143. Palm Bay, FL  32910-0453
  144.  
  145. Your registration key should be issued within two weeks of receipt of your
  146. completed registration form (allowing time for the check to clear).
  147.  
  148. For registration inquiries, just drop me an email (to lwpchart@homeside.com)
  149. with "Registration" in the subject.
  150.  
  151.                         Thank you for registering!
  152.  
  153.  
  154. ΓòÉΓòÉΓòÉ 4. Usage Hints ΓòÉΓòÉΓòÉ
  155.  
  156. As usage hints and questions (with answers) become available, they will be 
  157. posted on the WWW at http://www.teamos2.org/homeside/lwpchart. 
  158.  
  159.  
  160. ΓòÉΓòÉΓòÉ 5. Dialog Help ΓòÉΓòÉΓòÉ
  161.  
  162. The following sections contain the help panels for the various windows and 
  163. dialogs used by the LWPChart package. 
  164.  
  165.  
  166. ΓòÉΓòÉΓòÉ 5.1. Memory/Swap Window ΓòÉΓòÉΓòÉ
  167.  
  168.  Graph            The graph in this window displays currently free memory as 
  169.                   reported by OS/2 not including free swap space.  The scale of 
  170.                   this graph is dynamically scaled.  As memory free space 
  171.                   increases, the scale of the graph will decrease so that the 
  172.                   details of the changing memory use may be more easily seen. 
  173.                   Should the free memory decrease, the scale will increase in 
  174.                   response.  The memory level must change markedly for a period 
  175.                   of 30 sec for this rescaling to take place. 
  176.  
  177.  Top Number       The top number in the display on the left side of the client 
  178.                   area displays the amount of free RAM in your system.  It is 
  179.                   quite normal for this number to reduce to 512K and hover 
  180.                   there.  This indicates that OS/2 is using the swap file.  A 
  181.                   low number displayed here may not, in fact, be a problem 
  182.                   since OS/2 counts memory as "inuse" if it knows that is 
  183.                   loaded there.  This may be discardable resources that will 
  184.                   never be referenced again.  However, if this number 
  185.                   continually alternates colors and hovers at 512K, you could 
  186.                   probably use more RAM (also know as "mo-ram"). 
  187.  
  188.  Bottom Number    The bottom number is the current size of your swapfile as 
  189.                   identified by the SWAPPATH statement in the CONFIG.SYS file 
  190.                   on your current boot drive.  If this statement has been 
  191.                   modified since the last bootstrap, this number will not be 
  192.                   correctly reported. 
  193.  
  194.  Max Values       The box displays the current graph scale and the highest 
  195.                   recorded memory free in bytes.  The Average value is 
  196.                   informative if you have a constantly changing available 
  197.                   memory graph for the past four minutes. 
  198.  
  199.  
  200. ΓòÉΓòÉΓòÉ 5.2. CPU/Swap Window ΓòÉΓòÉΓòÉ
  201.  
  202.  Graph            The graph in this window displays CPU usage as a percent of 
  203.                   maximum. This window does not rescale, but maintains a 
  204.                   FullScale = 100% scale.  The heavier the load on the CPU, the 
  205.                   higher the graph.  The graph is updated every two seconds as 
  206.                   a rule (see the section on colors below). 
  207.  
  208.  Top Number       The top number in the display on the left side of the client 
  209.                   area displays the amount of free RAM in your system.  It is 
  210.                   quite normal for this number to reduce to 512K and hover 
  211.                   there.  This indicates that OS/2 is using the swap file.  A 
  212.                   low number displayed here may not, in fact, be a problem 
  213.                   since OS/2 counts memory as "inuse" if it knows that is 
  214.                   loaded there.  This may be discardable resources that will 
  215.                   never be referenced again.  However, if this number 
  216.                   continually alternates colors and hovers at 512K, you could 
  217.                   probably use more RAM (also know as "mo-ram"). 
  218.  
  219.  Bottom Number    The bottom number is the current size of your swapfile as 
  220.                   identified by the SWAPPATH statement in the CONFIG.SYS file 
  221.                   on your current boot drive.  If this statement has been 
  222.                   modified since the last bootstrap, this number will not be 
  223.                   correctly reported. 
  224.  
  225.  Colors           Normally the color of the numbers in this window are black on 
  226.                   white.  They turn to green and white when the system is more 
  227.                   idle than has yet been encountered. Normally, the program 
  228.                   awakens to measure the values displayed every two seconds. 
  229.                   If the time to awaken is more than one clock-tick (0.031 sec) 
  230.                   late, the numbers change to red on white to alert you to 
  231.                   this.  This may happen if the OS is busy doing something of 
  232.                   higher priority at the appointed wakeup time.  Should the 
  233.                   time to awaken be more than one clock-tick early, the numbers 
  234.                   will change to magenta on white to reflect this.  Often, if 
  235.                   OS/2 wakes up a process late, it will attempt to compensate 
  236.                   by awakening it the next time early, so you will often 
  237.                   observe a change to red numbers followed by a change to 
  238.                   magenta numbers. 
  239.  
  240.                   Black          Normal 
  241.                   Green          New maximum idle time detected. 
  242.                   Red            Wakeup was delayed to more than 2000 
  243.                                  milliseconds. 
  244.                   Pink           (actually Magenta) Wakeup was shorter than 
  245.                                  2000 milliseconds. 
  246.  
  247.  Max Values       The scale of the graph in this window does not change and 
  248.                   will always be 100.  The Min, Max, and Avg values may be 
  249.                   informative, however. 
  250.  
  251.  Note:  At times, this graph may begin displaying a steady, non-zero, busy 
  252.  percentage. This frequently occurs after a period of heavy system loading and 
  253.  indicates that LWPChart has detected an invalid maximum idle measurement. 
  254.  Simply close and restart LWPChart if this occurs.  Note also that active 
  255.  Windoze and/or DOS applications may indicate 100% CPU consumption until they 
  256.  are terminated. Closing and restarting LWPChart will not affect this 
  257.  indication. 
  258.  
  259.  
  260. ΓòÉΓòÉΓòÉ 5.3. IP Pkts Window ΓòÉΓòÉΓòÉ
  261.  
  262.  Graph            The graph displays the total PPS (Packets per Second) 
  263.                   exchanged, both transmitted and received.  The scale of this 
  264.                   graph is dynamically scaled.  As traffic increases, the scale 
  265.                   of the graph will decrease so that the details of the 
  266.                   changing traffic may be more easily seen.  Should the traffic 
  267.                   decrease, the scale will increase in response.  The traffic 
  268.                   level must change markedly for a period of 30 sec for this 
  269.                   rescaling to take place. 
  270.  
  271.  Top Number       The top number displays the current Received PPS. 
  272.  
  273.  Bottom Number    The bottom number displays the current Transmitted PPS. 
  274.  
  275.  Background 
  276.  
  277.                   White          Normal 
  278.                   Blue (Dark)    Graph recently rescaled to show a larger 
  279.                                  value. 
  280.                   Blue (Light)   (actually Cyan) Graph recently rescaled to 
  281.                                  show a smaller value. 
  282.  
  283.  Max Values       The box displays the current graph scale and the highest 
  284.                   recorded Total (Transmitted plus Received) PPS.  The Average 
  285.                   value is informative if you have been actively communicating 
  286.                   (for instance, a large FTP transfer) for the past four 
  287.                   minutes. 
  288.  
  289.  Note:  These graphs show the health of the TCP/IP connection to the internet. 
  290.  They cannot be used to evaluate how good or bad your modem connection might be 
  291.  beyond the effect of the connected baud rate. 
  292.  
  293.  
  294. ΓòÉΓòÉΓòÉ 5.4. IP Thru Window ΓòÉΓòÉΓòÉ
  295.  
  296.  Graph            This window's graph displays the IP throughput in bytes per 
  297.                   second. The scale of this graph is dynamically scaled.  As 
  298.                   traffic increases, the scale of the graph will decrease so 
  299.                   that the details of the changing traffic may be more easily 
  300.                   seen.  Should the traffic decrease, the scale will increase 
  301.                   in response.  The traffic level must change markedly for a 
  302.                   period of 30 sec for this rescaling to take place. 
  303.  
  304.  Top Number       The top number in this window shows the current bytes per 
  305.                   second received. 
  306.  
  307.  Bottom Number    The bottom number shows the current bytes per second 
  308.                   transmitted. 
  309.  
  310.  Background 
  311.  
  312.                   White          Normal 
  313.                   Blue (Dark)    Graph recently rescaled to show a larger 
  314.                                  value. 
  315.                   Blue (Light)   (actually Cyan) Graph recently rescaled to 
  316.                                  show a smaller value. 
  317.  
  318.  Max Values       The box displays the current graph scale and the highest 
  319.                   recorded Total (Transmitted plus Received) PPS.  The Average 
  320.                   value is informative if you have been actively communicating 
  321.                   (for instance, a large FTP transfer) for the past four 
  322.                   minutes. 
  323.  
  324.  Note: These graphs show the health of the TCP/IP connection to the internet. 
  325.  They cannot be used to evaluate how good or bad your modem connection might be 
  326.  beyond the effect of the connected baud rate. 
  327.  
  328.  
  329. ΓòÉΓòÉΓòÉ 5.5. TCP GvB Window ΓòÉΓòÉΓòÉ
  330.  
  331.  Graph            The graph plots the ratio of bad to total bytes at the TCP 
  332.                   layer.  It is graphed as a percentage.  It is calculated as 
  333.                   the number of bad bytes per second divided by the total bytes 
  334.                   per second (good bytes per second plus bad bytes per second), 
  335.                   the quotient multiplied by 100 to represent a percentage. 
  336.  
  337.                   For a solid connection, this graph should generally be empty. 
  338.                   Note, however, that when connected to the Internet, it is 
  339.                   normal for there to be a spike of bad packets when making and 
  340.                   breaking connections.  This spike has nothing to do with how 
  341.                   good (or bad) your IP connection is.  Also, read the note 
  342.                   below. 
  343.  
  344.  Top Number       The top number in this window shows the current bytes per 
  345.                   second received. 
  346.  
  347.  Bottom Number    The bottom number shows the current bytes per second 
  348.                   transmitted. 
  349.  
  350.  Background 
  351.  
  352.                   White          Normal 
  353.                   Blue (Dark)    Graph recently rescaled to show a larger 
  354.                                  value. 
  355.                   Blue (Light)   (actually Cyan) Graph recently rescaled to 
  356.                                  show a smaller value. 
  357.  
  358.  Max Values       The box displays the current graph scale and the highest 
  359.                   recorded Total (Transmitted plus Received) PPS.  The Average 
  360.                   value is informative if you have been actively communicating 
  361.                   (for instance, a large FTP transfer) for the past four 
  362.                   minutes. 
  363.  
  364.  Note:  There are some Internet sites which average 50% of bad vs. total bytes. 
  365.  These sites have a retransmission factor that does not account for the fact 
  366.  that you may be sitting on a relatively slow connection, and will not wait 
  367.  sufficiently long for your ACK.  This problem is often encountered on sites 
  368.  run under the Solaris OS, and is a bug in that OS.  A workaround for the 
  369.  problem may be found at: 
  370.  
  371.   http://access1.sun.com/cgi-bin/info2html?faqs/185402.faq
  372.  
  373.  I encourage you, when you encounter such a site, to email the server 
  374.  administrator of the site with a reference to the above URL. 
  375.  
  376.  Note: These graphs show the health of the TCP/IP connection to the internet. 
  377.  They cannot be used to evaluate how good or bad your modem connection might 
  378.  be.  Retries and/or dropped packets at the modem level do not appear in the 
  379.  TCP statistics. 
  380.  
  381.  
  382. ΓòÉΓòÉΓòÉ 5.6. LWPChart Settings ΓòÉΓòÉΓòÉ
  383.  
  384. This is the LWPChart Settings Dialog.  From this dialog you can select which 
  385. charts you wish to see.  You can also disable the startup about dialog so that 
  386. it does not appear.  This dialog is displayed by double-clicking the 
  387. right-mouse-button (RMB) on any chart or selecting "Properties" from any 
  388. chart's system menu. 
  389.  
  390. Note:  You must have at least one chart selected.  If you deselect the last 
  391. chart, a warning box will appear and the chart will be reselected 
  392. automatically. 
  393.  
  394. Note:  When a chart is deselected, there will be a delay of up to two seconds 
  395. as the window is destroyed on the next update interval.  If the CPU is 100% 
  396. busy, this delay may be longer due to the idle thread taking a while to 
  397. terminate. 
  398.  
  399.                This dialog is only available to registered users.
  400.  
  401.  
  402. ΓòÉΓòÉΓòÉ 5.7. Registration ΓòÉΓòÉΓòÉ
  403.  
  404. Why Register?  Well, the best reason is to compensate authors for work that you 
  405. find useful and valuable.  But what's in it for you is: 
  406.  
  407.      LWPChart will not automatically exit after one hour. 
  408.  
  409.      The splash dialog will auto-close two seconds after startup. 
  410.  
  411.      Settings will be available (double RMB click) to select window options. 
  412.  
  413.      You will receive automatic e-mail notification as updates are available. 
  414.  
  415.  To register, send this form and $10.00 (US) to: 
  416.  
  417.   Mr. Lynn W. Deffenbaugh
  418.   Homeside Software, Inc.
  419.   P.O. Box 100453
  420.   Palm Bay, FL  32910-0453
  421.   USA
  422.  
  423.  To get the latest version of LWPFTP, just check out the web page at 
  424.  http://www.teamos2.org/homeside/lwpchart. 
  425.  
  426.  Note:  Ten percent (10%, a full Biblical tithe) of all gross registration 
  427.  receipts will be donated to charities for the poor and homeless.