#
#      hyperSOURCE/386 Menu/Window Help
#      Filename: hs386hlp.txt
#      Date:  April 10, 1992
#
*F1 HELP
COMMANDS:
To get help on commands, type HELP or HELP <command>.  To get help on the 
menu bar, access the menu bar, move to the desired field, then press F1. 

MENU BAR:
There are two ways to access the individual fields on the menu bar.
  (1) Press F10, then use -> or <- cursor keys.
  (2) Press ALT and an appropriate letter key simultaneously. For example, 
      press ALT-S to access the Symbol menu. Press Esc to exit. 

COMMAND-LINE CONTROL KEYS:
  F1:                   Help
  F10:                  Go to the main menu bar
  F2 to F9:             Assignable from Macro:Key
  Alt  -F1 to -F10:     Assignable from Macro:Key
  Shift-F1 to -F10:     Assignable from Macro:Key
  Esc:                  Abort operation
  Ctrl-G:               Increase size of dialog window (grow)
  Ctrl-T:               Decrease size of dialog window (tiny)
  Up-Arrow:             Enter command history window
  Ins:                  Toggle insert mode
  Del:                  Delete a character
  Alt-0 to Alt-9:       Enter window 0 to 9; 0 is the command-line
  Alt-X:                Exit the debugger
*SOURCE WINDOW
  The source window allows you to browse through source code or
  disassembly while stepping through your code.

  F1:           Help
  F2:           Read source for the routine called at the cursor
  F3:           Select format (asm/source/mix, numbers on/off, code on/off)
  F5:           Toggle breakpoint at the cursor position
  F6:           Execute to the cursor position
  F7:           Execute one statement
  F8:           Execute one procedure call or statement
  F9:           Search the window for a pattern
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-G:        View at a new position (specify address, line, or symbol)
  Alt-X:        Exit the debugger
  Ctrl-G:       Increase size of dialog window (grow)
  Ctrl-T:       Decrease size of dialog window (tiny)
  Esc:          Return to the home window
  cursor keys:  Move within the window
  other keys:   Enter a command on the command line
*DIALOG WINDOW
  The dialog window holds all command input and output.  Use the LIST
  command to redirect its contents to a file.

  F1:           Help
  F9:           Search the window for a pattern
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Ctrl-G:       Increase size of dialog window (grow)
  Ctrl-T:       Decrease size of dialog window (tiny)
  Esc:          Return to the home window
  cursor keys:  Move within the window
*HISTORY WINDOW
  The history window holds all entered commands.  Use the JOURNAL command
  to redirect its contents to a file.

  F1:           Help
  F9:           Search the window for a pattern
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Ctrl-G:       Increase size of dialog window (grow)
  Ctrl-T:       Decrease size of dialog window (tiny)
  Enter:        Select the command line to be recalled
  Esc:          Return to the home window
  cursor keys:  Move within the window
*CTRACE WINDOW
  CallStack gives a list of currently active functions and their arguments.

  F1:           Help
  F2:           Return to the home window, leaving this window open
  F3:           Display local variables for the selected scope
  F9:           Search the window for a pattern
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-L:        Move or resize the window (change the Look)
  Alt-X:        Exit the debugger
  Enter:        Select the scope for source and local variable access
  Esc:          Return to the home window
  cursor keys:  Move within the window
*RTRACE WINDOW
  RunTrace displays collected trace information.

  F1:           Help
  F2:           Return to the home window, leaving this window open
  F5:           Clear the trace buffer
  F9:           Search backwards through window for a pattern
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-G:        Go to a specific frame (decimal, i.e., 1234t)
  Alt-L:        Move or resize the window (change the Look)
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
  cursor keys:  Move within the window
*REGISTER WINDOW
  The register window displays and allows editing of the current
  register values and descriptor tables.

  F1:           Help
  F2:           Return to the home window, leaving this window open
  F3:           Choices of other registers or tables to display 
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-L:        Move or resize the window (change the Look)
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
  cursor keys:  Move within the window
*REGISTER MENUS
ÚÄÄÄ¿
³386 ÄÄ 80386 Register Window
³387 ÄÄ 80387 Numeric Data Processor
³Gdt ÄÄ Global Descriptor Table
³Idt ÄÄ Interrupt Descriptor Table
³Ldt ÄÄ Local Descriptor Table
³Pd ÄÄÄ Page Directory
³Tss ÄÄ Task State Segment
ÀÄÄÄÙ
*PRE MEMORY
Enter the address (virtual, linear, physical, or symbolic) for memory
display.
*MEMORY SCROLLABLE
  The memory window displays and allows the editing of memory values
  in any of several format and size combinations.  Multiple memory
  windows can be active at any time.

  F1:           Help
  F2:           Return to the home window, leaving this window open
  F3:           Select the display format
  F4:           Select the memory object size
  F9:           Search memory for a pattern
  F10:          Go to the main menu bar
  Alt-0 to -9:  Enter window 0 to 9
  Alt-G:        Go to a new memory address
  Alt-L:        Move or resize the window (change the Look)
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
  cursor keys:  Move within the window
*FORMAT CLIST
ÚÄÄÄÄÄÄÄÄ¿
³Hex ÄÄÄÄÄÄ Display as base-16 unsigned values -- Byte shows ASCII too
³Octal ÄÄÄÄ Display as base-8 unsigned values
³Decimal ÄÄ Display as base-10 signed values
³Binary ÄÄÄ Display as base-2 unsigned values
³Real ÄÄÄÄÄ Display as 32-bit single precision floating-point values
³doUble ÄÄÄ Display as 64-bit double precision floating-point values
³Ten-byte Ä Display as 80-bit extended precision floating-point values
ÀÄÄÄÄÄÄÄÄÙ
*SIZE CLIST
Select the size to display Hex, Octal, Binary or Decimal formatted memory:

ÚÄÄÄÄÄ¿
³Byte ÄÄ  8-bit -- when in Hex format, ASCII will also be displayed
³Word ÄÄ 16-bit
³Dword Ä 32-bit
³Qword Ä 64-bit
ÀÄÄÄÄÄÙ
*MEMORY GO TO
Enter the new address (virtual, linear, physical, or symbolic) for
memory display.
*MEMORY SEARCH
Enter a list of values or a string to be searched for in memory
starting at the displayed location and ending at the end of the
segment.
*BREAKPOINT WINDOW
  The breakpoint window displays and allows the editing of execution
  breakpoints.

  F1:           Help
  F2:           Return to the home window, leaving this window open
  F3:           Enable or disable the highlighted breakpoint
  F10:          Go to the main menu bar
  Enter:        Edit the highlighted breakpoint
  Ins:          Add a new breakpoint
  Del:          Remove the highlighted breakpoint
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-L:        Move or resize the window (change the Look)
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*MENU HELP
Menu Descriptions:
    O/S: DOS related operations         Debug: Special debugging features
    Execute: Program execution          mAcro: Macro processing
    Memory: Memory display/edit         Window: Window management
    Register: Register display/edit     Config: Debugger configuration
    Symbol: Symbol display/edit         F1-Help: Confusion alleviation

*OS MENUS
ÚÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ Version ÄÄÄÄÄÄ Display debugger version number
³ Time ÄÄÄÄÄÄÄÄÄ Display the current time and date
³ OS shell ÄÄÄÄÄ Start-up a DOS shell
³ Exit ÄÄÄÄÄÄÄÄÄ Exit the debugger
ÀÄÄÄÄÄÄÄÄÄÄÄÄÙ
*EXECUTE MENUS
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ Load... ÄÄÄÄÄÄÄÄÄ Load a program to be debugged
³ Step ÄÄÄÄÄÄÄÄÄÄÄÄ Execute a statement (through calls)
³ Istep ÄÄÄÄÄÄÄÄÄÄÄ Execute an instruction (through calls)
³ steP intoÄÄÄÄÄÄÄÄ Execute a statement (into calls)
³ istep iNtoÄÄÄÄÄÄÄ Execute an instruction (into calls)
³ Go ÄÄÄÄÄÄÄÄÄÄÄÄÄÄ Go with breakpoints enabled
³ go Forever ÄÄÄÄÄÄ Go without breakpoints enabled
³ go Till ... ÄÄÄÄÄ Go until some address
³ go till rEturn ÄÄ Go until the current procedure returns
³ go till Call ÄÄÄÄ Go until a new procedure is active
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ
*HOST LOAD
Loads a program module into memory for debugging.  The program file 
can be an absolute file in Intel OMF86, OMF286 or OMF386 format. 

Examples:
       test1
       \project\test.omf
*GOTIL EXEC
Enter an address (virtual, linear, physical, symbolic, or a line
number).

Examples:
       cs:100h // virtual
       100hn   // linear
       100hp   // physical
       foo     // symbolic
       #27     // line number
*SYMBOL MENUS
ÚÄÄÄÄÄÄÄÄÄÄ¿
³ Evaluate ÄÄ Evaluate an expression
³ eXamine ÄÄÄ Examine, watch, or trace a symbol
³ Modules ÄÄÄ List the names of all modules and source files
³ Globals ÄÄÄ Display all global symbols
³ Locals ÄÄÄÄ Display currently active local variables
³ Structs ÄÄÄ Display defined structures
ÀÄÄÄÄÄÄÄÄÄÄÙ
*INFO EVAL
Evaluates an expression.  Full C expression syntax is supported.
Defined symbol names may be used in the expression as well as
names of the registers and flags.

Examples:
       ++count
       1fh + 77q + 101y + 98t
       '<'
       count + 8
*PRE SYMBOL
Enter the symbol or lvalue to be examined.
*SYMBOL EXAM
  The Symbol:Examine window displays and allows the editing, watching
  and tracing of symbols or lvalues (assignable expressions).  Tracing
  collects the values written to a location and the code addresses at
  which the writes occurred.

  F1:           Help
  F2:           Return to the home window, leaving this window open
  F3:           Trace this symbol
  F4:           Follow (dereference) the highlighted pointer
  F5:           Change the display format of the symbol value
  F10:          Go to the main menu bar
  Enter:        Edit the highlighted symbol
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-L:        Move or resize the window (change the Look)
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*SYM FORMAT CLIST
ÚÄÄÄÄÄÄÄÄ¿
³Hex ÄÄÄÄÄÄ Display as a base-16 unsigned value
³Octal ÄÄÄÄ Display as a base-8 unsigned value
³Decimal ÄÄ Display as a base-10 signed value
³Unsigned Ä Display as a base-10 unsigned value
³Real ÄÄÄÄÄ Display as a floating-point value
³ASCII ÄÄÄÄ Display as an ASCII character or C-style octal character
ÀÄÄÄÄÄÄÄÄÙ
*SYM DIR
  This window displays a list of symbols or modules.

  F1:           Help
  F9:           Search for a symbol
  F10:          Go to the main menu bar
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*SYMBOL DIR SEARCH
Enter a search pattern.
*SYM STRUCT
  The Symbol:Structs window displays the names of all tagged structs
  and unions and allows the display of their definitions.

  F1:           Help
  F10:          Go to the main menu bar
  Enter:        Select a struct definition for display
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*SYM A STRUCT
  The Struct window displays a structure template.

  F1:           Help
  F9:           Search
  F10:          Go to the main menu bar
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the Symbol:Structs window
*SYM MODULE
  The Symbol:Modules window displays the names of all modules in the
  program and allows the display of symbols defined within each module.

  F1:           Help
  F10:          Go to the main menu bar
  Enter:        Select a module for which symbols will be displayed
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*SYM MOD SYM
  The Module:Symbols window displays all of the symbols defined within
  a given module.

  F1:           Help
  F9:           Search for a symbol
  F10:          Go to the main menu bar
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the Symbol:Modules window
*DEBUG MENUS
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ BreakPoints ÄÄ Set or display execution breakpoints
³ CallStack ÄÄÄÄ Display the currently active procedures
³ RunTrace ÄÄÄÄÄ Display the execution trace buffer
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÙ
*BREAKPOINT DEFINE WINDOW
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³  ADDRESS:ÄÄÄÄÄ the program code address of interest
³    COUNT:ÄÄÄ¿  (may be virtual or linear address, symbol, or line number)
³CONDITION:ÄÄ¿ÀÄ the number of events before the breakpoint is triggered
³   ACTION:Ä¿ÀÄÄ a condition which must be satisfied before breaking 
ÀÄÄÄÄÄÄÄÄÄÄ ³    (may be any valid C integer expression) 
            ÀÄÄÄ a command to be executed after hitting the breakpoint
                 (may be a simple command or a macro invocation)
                
*CTRACE SEARCH
Enter a pattern for a textual search.
*RTRACE SEARCH
Enter a pattern for a textual search.
*MACRO MENUS
ÚÄÄÄÄÄÄÄÄ¿
³ Edit ÄÄÄÄ Edit or create a macro definition
³ Invoke ÄÄ Invoke a macro
³ Save ÄÄÄÄ Save a macro definition in a file
³ Load ÄÄÄÄ Load a macro definition from a file
³ Dir ÄÄÄÄÄ List the names of all defined macros
³ Remove ÄÄ Remove a macro definition
³ Key ÄÄÄÄÄ Define keyboard macros -- Also see the JOURNAL KEYBOARD command
ÀÄÄÄÄÄÄÄÄÙ
*MACRO EDIT
Enter the name of the macro definition to be created or edited.
*MACRO INVOKE
Enter the name of the macro to be invoked.
*MACRO SAVE
Saves the specified macro(s) in the specified text file.  If the
Macro Name field is left blank, all macros in the macro directory
will be written to the text file.
*MACRO LOAD
Enter the name of the file containing macro definition(s) and/or commands.
Commands are executed one at a time.  Each text line should contain only 
one command.
    
Examples:
       macrodef.inc
       \project\combo.cmd
*MAC DIR
  The Macro:Directory window displays a list of all macros and allows
  the display of any macro body.

  F1:           Help
  F10:          Go to the main menu bar
  Enter:        Select a macro to be displayed
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*MAC DISPLAY
  The Macro:Display window displays and allows the change of a macro body.

  F1:           Help
  F2:           Edit the macro body
  F10:          Go to the main menu bar
  Enter:        Select a macro to be displayed
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the Macro:Directory window
*MACRO REMOVE
Enter the name of the macro definition to be removed.
*SETUP KEYMACRO
  The Macro:Key window allows strings to be assigned to function keys
  for use on the command-line.  Strings can be assigned to F2 through F9,
  Shift-F1 through Shift-F10, and Alt-F1 through Alt-F10.  The key
  definitions can be saved in an environment file using the ENV command.

  F1:           Help
  F10:          Accept changes
  Enter:        Go to next field
  cursor keys:  Move within the window
  Alt-0 to -9:  Enter window 0 to 9
  Alt-X:        Exit the debugger
  Esc:          Return to the home window
*WINDOW MENUS
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ Select ÄÄÄÄÄÄÄ Select the a window to become active
³ Dump ÄÄÄÄÄÄÄÄÄ Dump a window's contents to a file
³ Resize/Move ÄÄ Select a window to resize or move
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÙ
*SELECT WINDOW
  The Window:Select window presents a list of windows from which a new
  active window may be selected.

  Return:       Select the window to be made active
  Esc:          Return to the home window
  cursor keys:  Move within the window
*DUMP WINDOW
  The Window:Dump window presents a list of windows from which one
  may be selected for a "snapshot."  The displayed contents of that
  window will be saved in the specified file.

  Return:       Select the window to dump
  Esc:          Return to the home window
  cursor keys:  Move within the window
*DUMP FILE
Enter the name of the file to which the window image will be saved.
*MOVE WINDOW
  The Window:Move window presents a list of windows from which one
  may be chosen to resize or move.  Once in the move/select mode,
  cursors move the window, Ctrl-cursors shrink the window, Shift-
  or Alt-cursors enlarge the window, Return or F10 accepts the new
  window size/position, and Esc cancels the change.

  Return:       Select the window to be moved or resized
  Esc:          Return to the home window
  cursor keys:  Move within the window
*WINDOW DRAG
  You are now in window move/resize mode.

  F1:           Help
  F10:          Accept the new size/position
  Enter:        Accept the new size/position
  cursor keys:  Move the window
  Ctrl-cursor:  Shrink the window in the specified direction
  Alt-cursor:   Enlarge the window (for separate cursor keypad)
  Shift-cursor: Enlarge the window (for numeric keypad)
  Esc:          Cancel the changes
*CONFIG MENUS
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³ Save configuration ÄÄÄÄ Save the current configuration
³ Case sensitivity ÄÄÄÄÄÄ Enable/disable case sensitive symbol access
³ Module <-> file ÄÄÄÄÄÄÄ Associate a source file with a module
³ EGA-43/VGA-50 line ÄÄÄÄ Enable/disable "tall" display mode
³ Input radix ÄÄÄÄÄÄÄÄÄÄÄ Set the default input radix
³ source Path ÄÄÄÄÄÄÄÄÄÄÄ Set/display the search path for source files
³ source Window format ÄÄ Set the display format for the source window
³ mAcro listing ÄÄÄÄÄÄÄÄÄ Enable/disable macro expansion listing
³ Beep ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ Enable/disable beeping on errors
³ Journal file ÄÄÄÄÄÄÄÄÄÄ Specify a journal file
³ List file ÄÄÄÄÄÄÄÄÄÄÄÄÄ Specify a list file
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ
*CONFIG ENV
Enter the name of the environment file.  Normally, this file is called
hs386.env unless changed by the HS386ENV DOS environment variable.
In the environment file, the # prefix specifies a comment.
*OPTION CAPITAL
ON makes symbolic reference case sensitive.   OFF makes symbolic
reference case insensitive.  Startup default is OFF.
*PROGRAM MODSET
Enter the module name and the source file to be associated with
the module.
*SETUP EGA
ON enables 43-line display mode on EGA monitor, or 50-line display
mode on a VGA monitor.  OFF returns to 25-line display mode.
*OPTION RADIX
ÚÄÄÄÄÄÄÄÄ¿
³Hex ÄÄÄÄÄÄ Make hexadecimal the default input radix
³Decimal ÄÄ Make decimal the default input radix
³Octal ÄÄÄÄ Make octal the default input radix
³Binary ÄÄÄ Make binary the default input radix
ÀÄÄÄÄÄÄÄÄÙ
*SOURCE PATH
Enter the semi-colon separated directory list to be used for source
file access.  Source files are always searched for in the current 
directory first.

Examples:
       \project\source
       c:\source;d:\proj\src
*OPTION VIEW
ÚÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³High level ÄÄÄÄÄ Display trace as source statements
³Assembly ÄÄÄÄÄÄÄ Display trace as assembler mnemonics
³Mixed ÄÄÄÄÄÄÄÄÄÄ Display both source and assembly
³Line numbers ÄÄÄ Enable or disable the display of line numbers
³Code display ÄÄÄ Enable or disable the display of object code
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÙ
*OPTION LINENUM
ON displays line numbers on Source Window.  OFF inhibits the display.
*OPTION CODE
ON displays object code on Source Window.  OFF inhibits the display.
*MACRO MLIST
ON displays the macro body during macro expansion.  OFF inhibits
the display.
*OPTION BEEP
ON enables beeping on errors.  OFF inhibits beeping.
*OPTION JOURNAL
Records all input commands in the specified text file.  The text
file may be used as an include file in a later debug session.

Examples:
       testcmd.txt
       \project\test\test.cmd
*OPTION LIST
Records all screen display in the specified text file.  The text
file provides a history of the debug session.

Examples:
       session.log
       \project\log\test.log