WBTitle Documentation

Designed and Implemented by Mark Thomas
This software is placed in the public domain.
You may modify the program or use the code in anyway you see fit.
I make no claims as to the code's fitness for use in any setting.
I make no claims as to the program's fitness for use in any setting.
Use the code or program at your own risk.


Motivation

I was reading someone's message on Usenet when something he said made
me come up with the idea for this program.  The actual technical
notion came from comments in the docs for the VMM virtual memory
program by Martin Apel.  Thanks for the clue on patching Intuition.

I also was concerned that there might not be any good source code
example on how to do SetFunction() from C.  The source code for this
program is in the archive.


Overview

WBTitle is a program that lets you replace your Workbench title bar
with just about any text you like.  It also gives you the facilities
to put memory readings in the title bar.  At its simplest, you could
replace the title bar with the same text that is already there, and
in the exact same format.  But WBTitle allows you to do more.


Features

The title bar replacement is partitioned into three main parts,
prefix, memory, and postfix.  They are combined in the order
prefix-memory-postfix to make the title bar text.

The prefix is just a string of text that appears at the leftmost part
of the title bar.  The memory consists of memory strings.  There can
be several items in the memory section, shown shortly.  The postfix
is simply some text that appears at the end of the title bar text.

As stated above, the memory can have several parts.  Each part is a
memory reading (amount of free memory with a label).  The memory
displays that are available are chip, fast, public, total, virtual,
and retina.  Chip, fast, public, and total are normal Amiga memory
options.  Virtual is for use with the VMM program for showing free
virtual memory.  Retina is for use with a Retina graphics card for
showing the amount of free graphics memory.

The memory reading consists of the memory value and a label (some
text).  All labels come either before the memory value or after the
memory value, which is determined by the LABELS option described
below.


Requirement

For the VMM virtual memory option to work, the library that comes
with VMM, "vmm.library", will have to be placed in LIBS:.


Options

All the options are specified in the tool types to keep the program
size small.  Tool types are entered from the Workbench by clicking
on the WBTitle icon and choosing Information... from the Icons menu.
Here are the tool types:

PREFIX

Lets you set the prefix text.
Default: "PREFIX=Amiga Workbench "

SUFFIX

Lets you set the suffix text.
Default: "SUFFIX="

LABELS

Lets you specify if the memory labels are placed before or after
the memory values so that you can do things like "Chip: 1,232,848"
or "1,012 KB Chip Mem".

MEMORDER

Allows you to set the order of the memory readings, as well as which
memory values are to be used.  It consists of a several letters that
you arrange in the order you want the readings.  Each letter stands
for a particular memory type:  C for chip, F for fast, P for public,
T for total, V for virtual, and R for Retina.
Default: "MEMORDER=CVPR"

CHIP

Lets you set the text that appears with the chip memory reading.
Default: "CHIP= Chip"

FAST

Lets you set the text that appears with the fast memory reading.
Default: "FAST= Fast"

PUBLIC

Lets you set the text that appears with the public memory reading.
Default: "PUBLIC= Public"

TOTAL

Lets you set the text that appears with the total memory reading.
Default: "TOTAL= Total"

VIRTUAL

Lets you set the text that appears with the virtual memory reading.
Default: "VIRTUAL= Virtual"

RETINA

Lets you set the text that appears with the retina memory reading.
Default: "RETINA= Retina"

THOUSANDSEP

Lets you choose whether memory values have a seperator before each
thousands group or not.  If this is set, your memory values would
have the format "1,228,352".  If this is not specified, your memory
values would have the foramt "1228352".
Default: there is not default

SEPERATOR

Allows you to set the character used to seperate the thousands groups
in memory values.  This is to allow for other countries.
Default: "SEPERATOR=,"

UNITS

Allows you to set the accuracy of the memory values.  It's easiest
to show an example.  If you have a memory value 1,228,352 and this
is set to 1, then that's exactly what you see, 1,228,352.  If you
wanted to see only how many kilobytes you have free, you can set the
value to 1024 and you would see 1,199, since that's the number of
kilobytes in 1,228,352.  So whatever value is the real memory
setting, it gets divided by this value.  Setting to 0 will end up as
a setting of 1 so that divides by zero are avoided.
Default: "UNITS=1"