Category : OS/2 Files
Archive   : MEMS20.ZIP
Filename : MEMSTAT.DOC

MEMSTAT - OS/2 Presentation Manager Memory Status Utility, Version 2.04
Copyright (C) 1991, 1992 The Software Cottage. All rights reserved.

For further information, contact:
Greg Jones,
The Software Cottage
71 Bruce Street,
Mount Waverley, Vic, 3149
AUSTRALIA.

Ph: 61-3-807-4939
Fidonet: 3:634/384.2
CompuServe: 100033,3121


What is MemStat?
----------------

MemStat Version 2.04 is a utility program which displays the current
amount of available memory, the size of the swap file and the amount
of free space on the swap drive under OS/2 2.x.

It has proven to be a useful tool, both in the test environment and
in the production environment.


Installation
------------

To install MEMSTAT, place MEMSTAT.EXE in a directory in your path,
MEMSTAT.HLP in a directory pointed to by your HELP environment
variable, and use STARTUP.CMD to start it or place it in your "Startup"
folder.


Operation
---------

MEMSTAT commences operation once it is started and displays the memory
and swap file status, updated at one second intervals.

When MEMSTAT receives a WM_SAVEAPPLICATION message, e.g. after
selecting Shutdown from the Workplace Shell Desktop, it saves its current
position to OS2.INI. The next time it is started MEMSTAT will move
its display window to that position. This allows you to place MEMSTAT
in a position suited to your working environment.


Release Notes for Version 2.04
------------------------------

Enhancements in this release
- MemStat now has a 'Hide Frame' option allowing the frame window
to be hidden. This allows MemStat to take up less room on the screen.
The frame display can now be toggled by double-clicking on the MemStat
display window with the left mouse button. When the frame is hidden,
MemStat can be moved about the screen by dragging the window using
the left mouse button.

- MemStat can now be configured to display a Short Description of the
values it is displaying, rather than the long description. Once again,
this takes up less screen space.

- MemStat now has a 'Float to Surface' option which causes MemStat to
force itself to be the top-most window on the screen. This allows
MemStat to be visible at all times if required.


Release Notes for Version 2.03
------------------------------

This is a release to make MemStat a 32-bit application. There have been
no bugs reported in Version 2.02.

Release Notes for Version 2.02
------------------------------

This is purely a bug-fix release to fix the problem of MemStat not
updating the memory status after the About... box is displayed.

Release Notes for Version 2.01
------------------------------

Enhancements in this release
- MemStat now displays the amount of disk space free on the swap drive.
- The MemStat display is now configurable through the Options pulldown
menu.
- MemStat now has on-line context-sensitive help.

Bug fixes in this release
- MemStat now displays the swap file size correctly when it is not on
Drive C:
- Fixed a problem with the way MemStat saved its position when
minimized.


The MemStat Display
-------------------
The MemStat Display window contains up to three lines of information
in this release. Depending on how you have set up MemStat, the
following information may be displayed:

Available Memory

This is the value returned from the DosMemAvail function call and
represents the size of the largest consecutive block of free memory
available when the function was called. Note that this is memory
available to 16-bit applications and may not be meaningful for 32-bit
applications running under OS/2 2.x.

Swap File Size

This is the physical size of the swap file, the location of which is
taken from the SWAPPATH parameter in CONFIG.SYS. Under OS/2 Version 2.x,
the swap file increases in size as your applications use memory and
decreases in size as physical memory becomes available so this value
will go up and down as you work.

Swap Disk Free Space

This value is the amount of free space left on the drive containing
the swap file. If this value goes too low, it is an indication that
you may need to make more space on your swap drive or move your swap
file to another drive.


MemStat Menus
-------------

The following pulldown menus are available for selection from within
MemStat:

Options
This menu allows the user to change the MemStat configuration, save
the position of MemStat on the desktop, and exit from MemStat. It contains
the following options:

Settings
This menu option brings up the MemStat Settings dialog box which
allows the user to alter the MemStat display. The user can tell
MemStat which parameters to display and can change the display
update interval to reduce the impact of MemStat on the system.
The settings selected by the user are saved in OS2.INI and retrieved
by MemStat when it is next loaded.

Save Position
Selecting this option allows the user to save the current position of
MemStat on the screen. The next time MemStat is run, it will be
displayed in the saved position. This option is automatically selected
when you select Shutdown from the Workplace Shell Desktop.

Exit
Selecting this option exits from MemStat.

Help
This menu allows the user to request help, and to display the About
dialog box. It contains the following options:

Help for help...
Selecting this option displays general help applicable to the Help
Manager and its use.

Extended help...
Selecting this option displays extended help and information for
MemStat.

Keys help...
Selecting this option results in the display of help for the keystrokes
available in MemStat.

Help index...
Selecting this option displays the Help Index for MemStat, allowing
the user to quickly find the desired help page.

About...
This option is used to bring up the MemStat About dialog box, which
displays copyright information about MemStat, including the current
version number.



MemStat Settings Dialog Box
---------------------------

To change any of the MemStat settings, click on the check boxes labelled:

Display Available Memory
Checking this box results in MemStat displaying the amount of physical
memory available to applications running under OS/2.

Display Swap File Size
Checking this box results in MemStat displaying the current size of the
swap file used by OS/2.

Display Swap Disk Free Space
Checking this box results in MemStat displaying the current amount of
free space on the drive on which the swap file is stored.

Hide Window Frame
Checking this box results in MemStat hiding its frame window when
displaying the requested information. This allows the MemStat window
to take up less room on the desktop. The frame display can be toggled
by double-clicking with the left mouse button on the MemStat display
window. When the frame window is hidden, the Memstat window may be moved
by selecting the window with the left mouse button and dragging the
window to the desired location.

Short Descriptions
Checking this box results in MemStat displaying shortened descriptions
of the information it is displaying. This allows the Memstat display
to take up less room on the desktop.

Float Memstat to Surface
Checking this box results in the MemStat display floating to the
surface when it is not the currently active window. This option is
useful when it is desired to monitor memory status while running
other applications which may take up the whole desktop.

Timer Interval
To change the Timer Interval, click on the edit field and enter a
numeric value between 0 and 65535. A value of 0 will cause the update
to occur as quickly as possible, that is, about every 1/18 of a second.

Any changes made to the above fields will not be reflected in MemStat until
the "OK" push-button is selected.

OK pushbutton
Selecting the OK pushbutton will result in the contents of the dialog
fields being checked and, if there is no invalid data, the data entered
will be saved and used by MemStat in displaying the memory status
information.

Cancel Push Button
Selecting the Cancel pushbutton will result in the dialog box closing
without saving any changes made to its fields.

Help Push Button
Selecting the Help pushbutton will result in help being displayed for
this dialog box.



About Dialog Box
----------------

The About Dialog Box gives some general information about MemStat,
including software copyright notices and the current version number.

Select "OK" to close the About Dialog Box.


Keys
----

The following keys are available for use within MemStat:

General Keys

F1
Get help

Alt+F4 or F3
Close MemStat

Alt+F5
Restore MemStat (when minimized)

Alt+F7
Move the MemStat window

Alt+F9
Minimize the MemStat window

Dialog Box Keys

Enter
Accept details and close dialog box

Esc
Cancel the dialog box

Spacebar
Set a check box on/off or perform the task described on the selected
pushbutton

Tab
Move to the next entry field or check box

Editing Keys

Backspace (left arrow delete)
Delete the character to the left of the cursor

Del
Delete the character at the cursor

End or Ctrl+Right Arrow key
Move to the end of a field

Home or Ctrl+Left Arrow key
Move to the beginning of a field.


MemStat Error Messages
----------------------

If an error occurs during execution, MemStat will attempt to display
a message reporting the error and will then take appropriate action.

Currently, MemStat will report the following errors:

"Unable to create Timer"
MemStat was unable to start a new system timer. This indicates that
the system timer limit has been exceeded. To fix this problem, close
some applications that use system timers and try MemStat again.

"Must select at least one parameter to display"
At least one Memory Status parameter must be selected for display. Check
at least one of the check boxes in the Settings dialog box.

"Invalid Timer Interval Entered"
The timer interval must be set to a value between 0 and 65535. A value
of 0 will cause the update to occur as quickly as possible, that is, about
every 1/18 of a second.

"Unable to Save OS2.INI Profile Entry"
MemStat was unable to save its Profile information to OS2.INI because
of a system error. Any settings changed in this session will need to be
changed again, the next time MemStat is run. To fix this problem, check
the validity of OS2.INI using an OS2.INI editor program to confirm that
it is readable. If not, restore your latest backup of OS2.INI.


Registering MemStat
-------------------

The easiest way to register that you are using MemStat is to send an
electronic mail note to Greg Jones at any of the addresses above. MemStat
is currently being distributed as freeware. By registering, you are
guaranteeing that you will find out when new releases are made.


Program License Agreement
-------------------------

MemStat is currently being distributed as a general interest utility.
You are free to copy and use the software for personal use and distribution
in its original, unmodified form provided no fee is charged beyond reasonable
media and/or shipping charges.

Corporate users interested in using MemStat are invited to contact
The Software Cottage regarding licensing.