Apple-2-Tools/AppleWin
1
0
Fork 0
mirror of https://github.com/AppleWin/AppleWin.git synced 2025-01-18 06:31:57 +00:00
Code Issues Projects Releases Wiki Activity

Help doc:

Browse Source 
. Added a new Debugger Screen Layout html page (to describe soft-switch status) (Fixes #406)
  - added a PPT doc which was used to generate the annotated screen layout image
. Added a note about Shift+LMB for toggling 6502 status flags (#483)
This commit is contained in:
tomcw 2017-12-20 18:07:23 +00:00
parent 607165cc9e
commit 355f5d0dd7
10 changed files with 96 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
help/Table of Contents.hhc
View File

@ -151,6 +151,10 @@
<param name="Name" value="Entering & exiting the debugger">
<param name="Local" value="dbg-entering-debugger.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Debugger Screen Layout">
<param name="Local" value="dbg-screen-layout.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Scrolling">
<param name="Local" value="dbg-scrolling.html">

10
help/dbg-entering-debugger.html
View File

@ -5,12 +5,12 @@
<meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
</head>
<body style="DIRECTION: ltr" lang="en-US">
<h2><a name="Debugger"></a>Entering the Debugger</h2>
<h2><a name="Entering-Debugger"></a>Entering the Debugger</h2>
<p>Start AppleWin, and press <b><font face="Courier, monospace">F7</font></b> to
enter the debugger.</p>
<p>The first thing you'll probably notice is the new syntax coloring in the
disassembly view, and info panel.&nbsp; All the colors can be customized to
your liking.&nbsp; See the <a href="#Colors">Colors</a> section for details.</p>
your liking.&nbsp; See the <a href="dbg-configuration.html#Colors">Colors</a> section for details.</p>
<p>Since the mini-console isn't the full width of the screen, you can toggle
between the full-screen console with the tilde '~' key. This style of table
will be used to designate which keys the debugger will recognize.</p>
@ -122,7 +122,7 @@
<br>
</p>
<h2><a name="Debugger"></a>Exiting the Debugger</h2>
<h2><a name="Exiting-Debugger"></a>Exiting the Debugger</h2>
<p>In general, press <b><font face="Courier, monospace">F7</font></b> to exit the debugger.<br>
NB. If you have breakpoints set then you will exit the debugger in 'stepping' mode.<br><br>
Other ways to exit the debugger and force 'stepping' mode are:
@ -152,7 +152,7 @@
</tr>
<tr>
<td width="14%">
<p>g</p>
<p>G</p>
</td>
<td width="25%">
<p>yes</p>
@ -169,7 +169,7 @@
</tr>
<tr>
<td width="14%">
<p>gg</p>
<p>GG</p>
</td>
<td width="25%">
<p>no</p>

11
help/dbg-execution.html
View File

@ -202,8 +202,8 @@
</tr>
<tr bgcolor="#cccccc">
<td width="35%">
<p>G&nbsp;[StopAddress]
</p>
<p>G&nbsp;[StopAddress]<br>
GG&nbsp;[StopAddress]</p>
</td>
<td width="65%">
<p><i>Resume execution until PC = StopAddress.</i></p>
@ -211,7 +211,8 @@
</tr>
<tr bgcolor="#999999">
<td width="35%">
<p>G&nbsp;[StopAddress]&nbsp;[SkipAddress,Length]</p>
<p>G&nbsp;[StopAddress]&nbsp;[SkipAddress,Length]<br>
GG&nbsp;[StopAddress]&nbsp;[SkipAddress,Length]</p>
</td>
<td width="65%">
<p><i>Resume execution until PC = StopAddress.<br>
@ -224,11 +225,13 @@
<p>####G</p>
</td>
<td width="65%">
<p><i>Alias for: R PC [=] address.</i></p>
<p><i>Alias for: R PC [=] address and then G.</i></p>
</td>
</tr>
</tbody>
</table>
<p><br>NB. The GG command resumes execution in full-speed. See <a href="dbg-entering-debugger.html#Exiting-Debugger">Exiting the Debugger</a>.
</p>
<p><br>
<br>
</p>

3
help/dbg-flags.html
View File

@ -6,13 +6,14 @@
</head>
<body style="DIRECTION: ltr" lang="en-US">
<h1>Flags</h1>
<p>Each flag can individually be set or cleared on the Processor Status Register ('<b>P</b>').&nbsp;
<p>Each flag can individually be set or cleared in the Processor Status Register ('<b>P</b>').&nbsp;
Cleared flags will show up with a normal background.&nbsp; Set flags will show
with an inverse background.
</p>
<br>
<p><font size="4"><b>Notes</b>:</font></p>
<ul>
<li> Shift+Left mouse button can be used to toggle the state of individual flags.</li>
<li>
<p style="MARGIN-BOTTOM: 0in"><i>The legacy commands <b>R</b>? and <b>S</b>?, where? is
a flag name (C,Z,I,D,B,R,V,N) has been left in.</i></p>

56
help/dbg-screen-layout.html Normal file
View File

@ -0,0 +1,56 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>AppleWin Debugger Tutorial</title>
<meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
</head>
<body style="DIRECTION: ltr" lang="en-US">
<h2></a><a name="Debugger Screen Layout"></a>Debugger Screen Layout</h2>
<p>This section gives an overview of the debugger's screen layout.</p>
<p>Here's a typical debugger view (with annotations describing the parts):</p>
<img src="img/debugger-layout-annotated.png" hspace="5" vspace="5">
<h3><a name="Soft-switches"></a>Soft-switches</h3>
<p>This encodes information about the video and MMU soft-switches.</p>
<p>The first 5 rows describe the current <b>video</b> settings and can be interpreted as follows:
<ul>
<li>50: $C050 - GR /TEXT (inverse indicates which is active)
<li>52: $C052 - FULL/MIX (inverse indicates which is active)
<li>54: $C054 - PAGE 1/2 (inverse indicates which is active)
<li>56: $C056 - LO/HIRES (inverse indicates which is active)
<li>5E: $C05E - DHGR/HGR (inverse indicates which is active)
</ul>
</p>
<p>The next 6 rows describe the current <b>MMU</b> settings and can be interpreted as follows:
<ul>
<li>00: $C000 - 80Sto0/1 (inverse indicates state of 80STORE)
<li>02: $C002-C005: Rm/xWm/x (NB. 'R' is blue and 'W' is red for readability)
<ul>
<li>Rm Read from main mem for $0200-$BFFF; Use OUT C002 to enable
<li>Rx Read from aux mem for $0200-$BFFF; Use OUT C003 to enable
<li>Wm Write to main mem for $0200-$BFFF; Use OUT C004 to enable
<li>Wx Write to aux mem for $0200-$BFFF; Use OUT C005 to enable
</ul>
<li>0C: $C00C - Col40/80 (inverse indicates state of 80COL)
<li>0E: $C00E - ASC/MOUS (inverse indicates state of ALTCHARSET)
<li>80: $C080-C087: B2/M R/W (Language Card Bank2)
<li>88: $C088-C08F: B1/M rNN (Language Card Bank1 and RAMworks 64K bank number)
<ul>
<li>'B2' or 'B1' is inverse when that LC bank is enabled.
<li>If 'M' is inverse: ROM is active for reading.
<li>If 'M' is not inverse: LC2 or LC1 RAM is active.
<li>If 'W' is inverse: RAM is write enabled.
<li>If 'W' is not inverse: RAM is write protected.
<li>'rNN' will appear if a RAMworks 64K bank is active.
</ul>
</ul>
</p>
<p style="MARGIN-BOTTOM: 0in"><br>
</p>
</body>
</html>

60
help/dbg-toc-intro.html
View File

@ -10,49 +10,29 @@
<P><FONT size="3">Revision 3.&nbsp; Mar 12, 2006.</FONT></P>
<H2>Table of Contents</H2>
<UL>
<LI>
<A href="#Introduction">Introduction</A>
<LI>
<A href="dbg-entering-debugger.html">Entering and exiting the Debugger</A>
<LI>
<A href="dbg-scrolling.html">Scrolling</A>
<LI>
<A href="dbg-registers.html">Registers</A>
<LI>
<A href="dbg-flags.html">Flags</A>
<LI>
<A href="dbg-execution.html">Execution</A>
<LI>
<A href="dbg-memory.html">Memory</A>
<LI><A href="#Introduction">Introduction</A>
<LI><A href="dbg-entering-debugger.html">Entering and exiting the Debugger</A>
<LI><A href="dbg-screen-layout.html">Debugger Screen Layout</A>
<LI><A href="dbg-scrolling.html">Scrolling</A>
<LI><A href="dbg-registers.html">Registers</A>
<LI><A href="dbg-flags.html">Flags</A>
<LI><A href="dbg-execution.html">Execution</A>
<LI><A href="dbg-memory.html">Memory</A>
<UL>
<LI>
<A href="dbg-memory.html#Memory_View">Viewing Memory</A>
<LI>
<A href="dbg-memory.html#Memory_Search">Searching Memory</A>
<LI>
<A href="dbg-memory.html#Memory_Change">Changing Memory</A>
</LI>
<LI><A href="dbg-memory.html#Memory_View">Viewing Memory</A>
<LI><A href="dbg-memory.html#Memory_Search">Searching Memory</A>
<LI><A href="dbg-memory.html#Memory_Change">Changing Memory</A>
</UL>
<LI>
<A href="dbg-symbols.html">Symbols</A>
<LI>
<A href="dbg-calculator.html">Calculator</A>
<LI>
<A href="dbg-windows.html">Windows</A>
<LI>
<A href="dbg-breakpoints.html">Breakpoints</A>
<LI>
<A href="dbg-configuration.html">Configuration</A>
<LI><A href="dbg-symbols.html">Symbols</A>
<LI><A href="dbg-calculator.html">Calculator</A>
<LI><A href="dbg-windows.html">Windows</A>
<LI><A href="dbg-breakpoints.html">Breakpoints</A>
<LI><A href="dbg-configuration.html">Configuration</A>
<UL>
<LI>
<A href="dbg-configuration.html#Colors">Colors</A>
<LI>
<A href="dbg-configuration.html#Fonts">Fonts</A>
<LI>
<A href="dbg-configuration.html#Scripts">Scripts</A>
<LI>
<A href="dbg-configuration.html#Settings">Settings</A>
</LI>
<LI><A href="dbg-configuration.html#Colors">Colors</A>
<LI><A href="dbg-configuration.html#Fonts">Fonts</A>
<LI><A href="dbg-configuration.html#Scripts">Scripts</A>
<LI><A href="dbg-configuration.html#Settings">Settings</A>
</UL>
</LI>
</UL>

4
help/dbg-windows.html
View File

@ -5,9 +5,9 @@
<meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
</head>
<body style="DIRECTION: ltr" lang="en-US">
<h2><a name="Calculator"></a><a name="Windows"></a>Windows</h2>
<h2><a name="Windows"></a>Windows</h2>
<p>Due to the amount of information available, the debugger now features
"windows."&nbsp; You can switch to th full screen console to read the help, or
"windows".&nbsp; You can switch to the full screen console to read the help, or
to the data window to view memory.</p>
<p><br>
<br>

BIN
help/img/debugger-layout-annotated.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 54 KiB

BIN
help/resources/Debugger-screen-layout.pptx Normal file
View File

Binary file not shown.

BIN
help/resources/debugger-layout.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB