@DATABASE "ShowMem"
@$VER: ShowMem.guide 1.06 (27.3.99)
@(C) THOR Software
@SMARTWRAP
@AUTHOR Thomas Richter
@NODE MAIN "ShowMem Guide"
                        ShowMem Guide

Guide Version 1.06                      ShowMem Version 2.06



Table of Contents


I.      @{"The Licence" link Licence}

                Read This First!


II.     @{"What is it: Overview" link Overview}

                What it does...


III.    @{"Installation" link Install}

                How to install ShowMem.


IV.     @{"Configuration" link Config}

                Customize ShowMem.


V.      @{"History" link History}

                What happened before.



        © THOR-Software

        Thomas Richter

        Rühmkorffstraße 10A



        12209 Berlin


        Germany



EMail:  thor\@einstein.math.tu-berlin.de

WWW:    http://www.math.tu-berlin.de/~thor/thor/index.html


ShowMem is FREEWARE and copyrighted © 1993-1998 by
Thomas Richter. No commercial use without perimission of the
author. Read the @{"licence" link Licence}!

@ENDNODE
@NODE Licence "The THOR-Software Licence"
                         The THOR-Software Licence (v2, 24th June 1998)


This License applies to the computer programs known as "ShowMem" and
the "ShowMem.guide". The "Program", below, refers to such program. The
"Archive" refers to the package of distribution, as prepared by the author
of the Program, Thomas Richter. Each licensee is addressed as "you".



The Program and the data in the archive are freely distributable
under the restrictions stated below, but are also Copyright (c)
Thomas Richter.

Distribution of the Program, the Archive and the data in the Archive by a
commercial organization without written permission from the author to any
third party is prohibited if any payment is made in connection with such
distribution, whether directly (as in payment for a copy of the Program) or
indirectly (as in payment for some service related to the Program, or
payment for some product or service that includes a copy of the Program
"without charge"; these are only examples, and not an exhaustive enumeration
of prohibited activities).


However, the following methods of distribution
involving payment shall not in and of themselves be a violation of this
restriction:


(i) Posting the Program on a public access information storage and
retrieval service for which a fee is received for retrieving information
(such as an on-line service), provided that the fee is not
content-dependent (i.e., the fee would be the same for retrieving the same
volume of information consisting of random data).


(ii) Distributing the Program on a CD-ROM, provided that

a) the Archive is reproduced entirely and verbatim on such CD-ROM, including
especially this licence agreement;

b) the CD-ROM is made available to the public for a nominal fee only,

c) a copy of the CD is made available to the author for free except for
shipment costs, and

d) provided further that all information on such CD-ROM is redistributable
for non-commercial purposes without charge.


Redistribution of a modified version of the Archive, the Program or the
contents of the Archive is prohibited in any way, by any organization,
regardless whether commercial or non-commercial. Everything must be kept
together, in original and unmodified form.




Limitations.


THE PROGRAM IS PROVIDED TO YOU "AS IS", WITHOUT WARRANTY. THERE IS NO
WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
SERVICING, REPAIR OR CORRECTION.


IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE THE PROGRAM, THE ARCHIVE
AND ALL DATA OF THIS ARCHIVE FROM YOUR STORAGE SYSTEM. YOU ACCEPT THIS
LICENCE BY USING OR REDISTRIBUTING THE PROGRAM.


                                                        Thomas Richter


@ENDNODE
@NODE Install "Installation"
The "Installation" of ShowMem is in fact very easy:

        -> Just copy it whereever you want it.

@ENDNODE
@NODE Config "Configure ShowMem"
There's not much configuration to be done, but you may customize the colors
used for the memory display, as well as the initial position of the window.


Select the "ShowMem" icon, then select "Info" from the workbench menu to
adjust the tooltypes; the following tooltypes are recognized by "ShowMem":



@{B}LEFTEDGE@{UB}:

The initial left edge coordinate of the memory display window.


@{B}TOPEDGE@{UB}:

The initial top edge of this window.


@{B}WIDTH@{UB}:

The width of the window, in pixels.


@{B}HEIGHT@{UB}:

The height of the window, again in pixels.



The next options allow to setup specific colors for the different memory
types available. At least V39 of the AmigaOs is required for these options.


@{B}ALLOCATED@{UB}:

The color to be used for allocated memory, given as red, green and blue
components of the color in hexadecimal notation. 0xffff is maximum intensity
of the color, 0x0000 is minimum. ShowMem will try to find the closest
possible color available, which may or may not very close if the screen
offers only very few available pens.

This color defaults to white.


@{B}FAST@{UB}:

The color for available "fast" memory. This defaults to blue.


@{B}CHIP@{UB}:

The color of "chip" memory. This is by default black.


@{B}OTHER@{UB}:

The color of all other kinds of memory, defaults to red or grey.


@{B}TEXT@{UB}:

The color for the text in the memory display, showing the start
address of the memory. This text is, by default, printed in the same color
as the free memory within this memory block.


@{B}FILL@{UB}:

The color under this text. By default identically to the color of allocated
memory blocks.


@ENDNODE
@NODE Overview "Overview about ShowMem"
ShowMem is a tiny tool that shows the memory layout, i.e. shows which chunks
of memory are used and which are free.

Once you have @{"installed" link Install} ShowMem, double clicking on its
icon opens the memory layout window. The window itself is split into several
(usually two) vertical regions, one for each type of memory available. The
start address of each memory node is printed on top of it.

Below the number, the available memory chunks of this node are displayed. A
(usually) white part of the window indicates a used part of the memory, a
colored part encodes a free (still available) part of memory. The color used
indicates the type of memory (the colors printed here are due to the CBM
standard colorset of the workbench 2.0 or newer):


        @{FG Shine}White:@{FG Text}          Used memory

        @{FG Fill}Blue@{FG Text}:           Fast Mem

        Black:          Chip Mem

        @{FG Background}@{BG Text}Grey@{FG Text}@{BG Background}:
          Unknown memory.



You may also have a look at the @{"picture" SYSTEM "Multiview ShowMem.pic"}.

@ENDNODE
@NODE History "History"
Version 2.00:           First public AmiNet release.


Version 2.01:           Added the tooltypes LEFTEDGE,TOPEDGE,WIDTH,HEIGHT
for free configuration of the window and its position.


Version 2.02:           The 2.01 passed illegal parameters to the
gfx.library RectFill() vector. Fixed.


Version 2.03:           Due to a forgotten flag, the AUTOADJUST feature
of the window did not work. Passing too large parameters to width and
height is now respected. Included again the picture.


Version 2.04:           Fixed a stupid bug that could have caused enforcer
hits in very rare cases (in case the number of MemHeaders changed while
ShowMem was investigating this list).
Added a dummy BeginRefresh/EndRefresh to be 100% Intuition conformal.
Re-arranged the AllocMem/FreeMem patches to be able to run ShowMem with
MemSniff installed. However, please note that in general MemSniff DOES NOT
allow any patches on top of its own patch, ShowMem is an exception.


Version 2.05:           Made the colors configurable by tooltypes.


Version 2.06:           Due to round-off errors, ShowMem might have messed
the window border. Fixed.

@ENDNODE

