A
          HeadRoom Swap Manager Version 1.00
                Help file release 1.00
      Copyright(c) 1988, Helix Software Co., Inc.

Please read the HeadRoom documentation carefully before 
attempting to run HeadRoom.  Even expert users should 
examine the documentation, and at least glance at the 
tutorial section in order to learn how to load TSRs into 
HeadRoom. These help screens are intended only as 
reminders, not as a substitute for the documentation.

Press space to continue.

                Using the help system:

To use the HeadRoom help facility you may press function 
key F1 at any prompt or menu to get some information on 
what HeadRoom expects, and what options are available.

The help screen will display one "window" full of informa- 
tion and then pause.  You may hit ESC to quit the help 
section, PgUp to view the previous screen full, Home to go 
back to the beginning of the current section, or any other 
key to view the next screen full.

              The HeadRoom Main Menu:

The HeadRoom menu consists of a list of all TSRs and 
application programs (Apps for short) that HeadRoom has 
swapped out.  The first column contains the name of the 
TSRs/Apps. 

Each TSR or App may have an asterisk printed to the left 
of its name.  The * signifies that the TSR or App is 
currently loaded into conventional memory.  You may have 
several TSRs, but only one App loaded.

The second and third columns on the HeadRoom menu 
describe the primary activation keys for each TSR/App. 
(for more info press F3 then F1).

The third column is the screen mode of the TSR. This 
will show "Any" if the TSR is capable of popping up in 
graphics modes, or "Text" if HeadRoom will switch the 
screen to text mode before swapping the TSR into memory. 
(for more info press F2 then F1).

The last column describes the swapping method used for 
the TSR/App.


           Main Menu Functions and Keys:

One of the TSRs/Apps is highlighted. This is the 
currently selected HeadRoom entry.  Function keys F2, F3 
and F10 all operate on the highlighted TSR.

You can change the currently selected TSR/App by 
pressing Space, Backspace, any of the arrow keys, PgUp, 
PgDn, Home, End, Ctrl/Home or Ctrl/End.  Or, by typing 
the first letter in the name of the TSR/App.

F2 allows you to modify various parameters pertaining to 
an individual TSR/App.  Namely, the name of the TSR/App, 
its memory usage and allocation, its display mode, and 
when and how to swap the TSR/App into memory to handle 
various events.

F3 allows you to define from one to ten activation keys 
for each TSR/App.  When you press one of the keys 
defined for the TSR/App, HeadRoom will swap the TSR or 
App into memory. (Press F3 then F1 for more info).

F10 loads the TSR/App highlighted on the HeadRoom menu 
into conventional memory so that you may pop it up.

Other Functions:

From the HeadRoom main menu you may also use function 
key F4 to change various other parameters, such as the 
HeadRoom activation key.  F4 also allows you to perform 
application swapping.

Finally, Alt/C lets you change the window colors, and 
ESC exits from HeadRoom.

B
                   Activation Keys:

This function lets you define up to ten activation keys 
for each TSR/App that is loaded into HeadRoom.

The activation key menu is broken up into ten sections, 
each section representing one of the ten possible 
activation keys.  One of the ten sections is highlighted.

If a key has not been defined for a section, that section 
will show "None".  If a key has been defined, the key will 
be displayed in the "Key" column, and any modifier keys 
(left-shift, right-shift, Ctrl or Alt) will be shown in 
the "shft" column.
 
You may define an activation key as a key with no 
modifiers (F1), a key with modifiers (Ctrl/Alt/F1), or 
modifiers without a key (Ctrl/Alt).

To define an activation key move the highlight bar, using 
the arrow keys, to the section you want to define, and 
press Enter.  HeadRoom will pop up a new window allowing 
you to define the activation key.

If you want to define an activation sequence made up of 
modifiers without any key (such as the Genie activation 
sequence of left-shift/right-shift) simply hold down the 
modifier keys for two seconds.  HeadRoom will catch on.

To remove an activation key, select it, and press Del.

When the keys are defined to your satisfaction, press F10.

If you do not want to make any changes press ESC.

IMPORTANT: IF YOU PRESS ESC ANY CHANGES YOU MADE TO YOUR 
ACTIVATION KEYS WILL BE LOST -- THE KEYS WILL REVERT TO 
THEIR PREVIOUS STATE.  So, press F10 when you are done, 
and ESC only if you've made an error.

Please note that the key in the first ( 0 ) position is 
the key that is displayed on the HeadRoom main menu.

D
                  Change Parameters:

This menu lets you modify several options pertaining to a 
specific TSR/App.

Memory usage: displays the amount of memory used by the 
TSR/App, and lets you re-allocate the TSR/App's swapping 
to expanded memory, extended memory, or disk.

New name: Changes the name of the TSR/App as it is 
displayed on the HeadRoom main menu.

Swap-in events: Sets one of several hardware or software 
events as a trigger, causing HeadRoom to swap the TSR/App 
into conventional memory.

Display mode: Sets a TSR's screen mode, forcing HeadRoom 
to switch the screen to text mode before loading a TSR.

Remove/unload: Removes the TSR/App from the HeadRoom 
menu, freeing up the memory (expanded, extended or disk) 
being used to store the swapped-out image of the TSR/App.  
If the TSR is swapped to disk you will be prompted as to 
whether you would like to delete the swap file.

To perform one of these functions, you must move the 
highlight bar to the function you want to perform.  

You may move the highlight bar using the arrow keys, 
space and backspace, Home and End keys, or by pressing the 
first letter of the function you want.   If more than 
one function starts with the same letter, pressing the 
letter again will move to the next.

E
                    Swap-in events:

This menu lets you define various events that will cause 
HeadRoom to swap a TSR/App into conventional memory.

For instance the At a particular time event lets you set 
a specific time at which, to the nearest minute, HeadRoom 
will swap the TSR/App into memory.

For specific information on each event, refer to the 
HeadRoom documentation.  Also be sure to check the 
section regarding the XRUN.EXE expanded memory loader.

To set one of the Swap-in events, move the highlight bar 
to the event you want to set and press Enter.  

You may move the highlight bar using the arrow keys, 
space and backspace, Home and End keys, or by pressing the 
first letter of the function you want.   If more than one 
function starts with the same letter, pressing the letter 
again will move to the next.

Each event, once set will be displayed on the menu with 
an asterisk.  To clear an event simply move the 
highlight bar to it again, and press Enter.  The event 
will be cleared, and the * will not be displayed.

To clear the At a particular time event, set the time to 
00:00:00.  To set an At a particular time swap-in event 
for midnight set the time to 00:00:01.

J
                       New name:

This function lets you set the name of the TSR/App as it 
is displayed on the HeadRoom main menu.  Set the name to 
any string of characters that is meaningful to you.  The 
name may be up to 20 characters long.

You may use Del, Home, End, and Ctrl/End as well as the 
arrow keys when editing the text.

K
                    Window colors:

This function lets you change the colors of any window.

Windows in HeadRoom are made up of three sections: The 
window border, the window text, and the highlight bar.

You may set the colors of each of these three regions to 
any one of 240 color combinations (16 foreground, and 16 
background).

To select the section whose color you wish to change 
press the TAB key. The section that you can modify will 
blink.  Each time you press the TAB key the next section 
will be selected, and the selected section will blink off 
and on.

To set the color of the selected section use the arrow 
keys.  The up and down keys will change the background 
color, while the left and right keys will change the 
foreground color.

When you've selected the colors for one section, press 
TAB to go to the next section.

When you've set all the colors for the current window, 
press Enter to accept the colors as they are, or ESC to 
return to the default colors.

To save the colors you set, use the Save configuration 
Function of the F4 options menu.

L
                   Screen mode:

This function instructs HeadRoom to make sure that the 
screen is set to text mode before swapping a TSR into 
conventional memory.  This will ensure that the TSR you 
are swapping into memory will not damage the screen of a 
graphics application.

This is particularly useful if you have a one of the 
newer display adapters, such as the EGA, VGA or MCGA. 
Setting this function to "Text mode set before swap" 
makes HeadRoom save the screen each time it swaps a TSR 
into memory.  HeadRoom can then restore the screen 
properly once you've finished using the TSR.

However, setting HeadRoom to "Text mode set before swap" 
slows down the swapping of TSRs.  So, if your TSR works 
properly with graphics applications, leave this function 
set to "Display mode unchanged".

To select one of the two display modes, move the 
highlight bar to the mode you want to set and press 
Enter.  

You may move the highlight bar using the arrow keys, 
space and backspace, Home and End keys, or by pressing the 
first letter of the mode you want.

The current mode is indicated with an asterisk (*) to 
the left of the menu entry.

M
                     Memory usage:

This function allows you to change the location to/from 
which HeadRoom swaps a TSR/App.  If a TSR/App is currently 
in expanded or extended memory you may move it to disk.  
If it is on disk you may move it to expanded or extended 
memory.

The options available here are:

Set to swap from expanded memory: (if the TSR/App is on 
disk) loads the swap image into expanded memory, if enough 
is available, and lets you delete the disk swap file.

Set to swap from extended memory: (if the TSR/App is on 
disk) loads the swap image into extended memory, if enough 
is available, and lets you delete the disk swap file.

Write memory image to disk: (if the TSR/App is in 
expanded or extended memory) saves an exact image of the 
TSR/App from expanded/extended memory to a disk swap 
file.  The file can be used as a backup, and can be 
re-loaded at any time.  Swapping continues to/from 
memory.

Set to swap to disk file: (if the TSR/App is in expanded 
or extended memory) moves the image of the TSR/App from 
memory to a disk file, and frees the memory occupied by 
the swap image.  Swapping continues to/from disk.

Remove & free memory: (in all cases) removes the TSR/App 
from the HeadRoom main menu and frees the memory 
occupied by the swap image.  If the TSR/App was swapping 
to disk, HeadRoom will prompt you as to whether or not 
the disk swap file should be deleted.

To perform one of these functions, you must move the 
highlight bar to the function you want to perform.  

You may move the highlight bar using the arrow keys, 
space and backspace, Home and End keys, or by pressing the 
first letter of the function you want.   If more than 
one function starts with the same letter, pressing the 
letter again will move to the next.

O

                Error/Warning Window!!

An error has occurred, or HeadRoom requires some important 
information from you.  A message is displayed in a window 
currently covered by this help screen.  Please read the 
message in the window carefully and take appropriate 
action.

For more information on the message please check the 
HeadRoom documentation.
Q
                       Options:

This menu lets you perform various functions related to 
the operation of HeadRoom.  These functions are NOT 
related to a specific TSR/App.  In brief, these functions 
perform the following functions:

Swap out current application:  HeadRoom saves an exact 
image of the program that was running when HeadRoom was 
popped up, and loads in a new copy of DOS.  You may run 
another program or simply use DOS. 

At any time, HeadRoom can re-load the saved image, so 
that you can go back to the program that you swapped out.  
You may repeat this process up to 32 times.

Save configuration:  HeadRoom saves copies of all 
TSR/Apps currently loaded.  Next time you load HeadRoom 
into memory, HeadRoom automatically loads all the TSR/Apps 
for you so that they are ready to be activated.

Disable/Enable all activation keys: HeadRoom temporarily 
shuts down all TSR/App activation keys, preventing 
interference with the foreground program.  This function 
toggles between Disable and Enable, and when keys are 
disabled the "Key" and "Shift" columns on the HeadRoom 
main menu are blanked out with asterisks.

Show/Hide application reminder: HeadRoom displays the 
name of the currently loaded application in the upper 
right hand corner of the screen.  This only works if you 
have swapped out at least one application.

Clear all swap-in events: HeadRoom disables all swap-in 
events for all TSRs and applications.  You have to re-set 
swap in events manually or re-load HeadRoom.

Move all to disk: HeadRoom moves the image of each 
TSR/App from expanded or extended memory to a disk file, 
and frees the memory occupied by the swap image.  Swapping 
of the TSR/App continues to/from disk.

Remove/clear all programs: HeadRoom removes all TSR/Apps 
loaded in expanded or extended memory or on disk, and 
frees the memory they occupy.  HeadRoom prompts, asking 
whether it should delete the swap files for the disk based 
TSR/Apps.

HeadRoom activation key: Lets you set a new activation 
key with which to access HeadRoom.

Load a swap file: HeadRoom loads in a previously saved 
swap file, and lets you use the TSR/App image contained in 
the file.

Change default swap directory:  HeadRoom prompts you for 
the directory in which you want to store the HeadRoom swap 
files and the HeadRoom configuration file.

Delete unused swap files: HeadRoom searches the swap 
directory for any files with the swap (".SWP") extension, 
and lets you delete any files that are not currently being 
used for swapping.  You are prompted with the name of each 
file. This is a convenient way of deleting unwanted swap 
files, while ensuring that you do not accidentally delete 
a file that is actively being used to swap a TSR/App.

S
                   Application name:

This function allows you to set the name of the 
application you are swapping out of memory.  The name you 
enter will appear on the HeadRoom main menu, and, 
optionally, be displayed on the upper right hand corner of 
your screen.

You may accept the default name by pressing Enter, or 
change it using Del, Home, End, Ctrl/End and the arrow 
keys to edit the text.

T
             Application swap destination:

This menu lets you choose where you would like to place 
the image of the application being swapped out.  You may 
swap any application to expanded memory, extended memory 
or to disk.

Swapping to disk is much slower (100 to 1000 times 
slower) than swapping to expanded memory, but you 
need approximately 800K of expanded/extended memory 
free, and you may be able to use the memory for your 
applications.

V
        Application Initialization Options:

When HeadRoom re-loads an application that has been 
saved through a "Save configuration" it can set up the 
application in one of two ways:

Initialize from current image:  This option tells 
HeadRoom to save a copy of the swapped out image of the 
application.  If the application is swapped to expanded or 
extended memory, then the image of the application is 
saved to a regular swap image file (".SWP").  If the 
application is swapped to disk, HeadRoom copies and 
compresses the current swap image file, creating a 
compressed (".SW1") swap image file.

If this option is selected, HeadRoom will use the saved 
copy to initialize the swapped partition.  So, the next 
time you load HeadRoom and swap the application back into 
memory, the application will be at the exact spot you left 
it when you told HeadRoom to "Save configuration".

The drawback of this method is that disk files may no 
longer be in the same state they were in when you 
performed the "Save configuration".  Since there is no way 
to restore the disk files to their previous state, we only 
recommend that you use this option if you are certain that 
the application you are saving is NOT MAINTAINING ANY OPEN 
FILES. See the documentation for more information on this 
topic.



Initialize from a DOS command:  Selecting this option 
tells HeadRoom to ignore what is currently swapped out.  
Then, each time HeadRoom is loaded, HeadRoom clears out 
the application's swap partition, and runs the command or 
batch file you specify.  This way a new copy of the 
application is loaded whenever you load HeadRoom, 
guaranteeing no mishaps. Furthermore, you save the disk 
space that would be required to hold the application's 
image.

The drawback of this method is that you have to wait for 
the application to reload, rather than having it 
immediately available.

X

                Batch File Mini-Editor:

This window lets you edit the batch file you named in the 
previous section.  You may enter commands and move around 
using the arrow keys, Home, End, Ins and Del.  Also, 
Ctrl/End erases text from the cursor through the end of 
the line and Ctrl/Home erases the entire line.

When you've finished editing you may press F10 to save 
the changes you made, or ESC to quit without saving the 
changes.  The "Save configuration" will continue.

Y

                   Swap File Delete:

This window lets you delete swap files that are not 
currently in use by HeadRoom.  HeadRoom will display 
each swap file name.  You may press F10 to delete the 
file, or ESC if you do not want to delete the file.

In either case, HeadRoom will search for the next unused 
swap file and allow you to delete it.

Z

            Change Default Swap Directory:

You may enter a new directory name as the swap directory 
HeadRoom will use to store swap files.  You must enter a 
valid directory path, or HeadRoom will generate an error 
message.
z
                                                                                                                                                                                                  
