mirror of
https://github.com/fadden/6502bench.git
synced 2025-09-12 10:24:38 +00:00
cae1fa5173
Added assembler regression tests, for 6502 and 65816. The "remove formatting" action now clears the flag. It's a bit of a stretch to call it "formatting" but this feels right. Updated the documentation, adding a new section about embedded instructions to the intro material.
243 lines
11 KiB
HTML
243 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<link rel="stylesheet" href="main.css"/>
|
|
<title>Contents - 6502bench SourceGen</title>
|
|
</head>
|
|
|
|
<body>
|
|
<div id="content">
|
|
<h1>6502bench SourceGen Reference Manual</h1>
|
|
<p>SourceGen is an interactive disassembler for 6502, 65C02,
|
|
and 65816 code. The official web site is
|
|
<a href="https://6502bench.com/">https://6502bench.com/</a>.</p>
|
|
|
|
<p>If you want to get up to speed quickly, start with the
|
|
<a href="https://6502bench.com/sgtutorial/">tutorials</a>.</p>
|
|
|
|
<div id="webwarn" style="display:none;">
|
|
<p style="color:red;">
|
|
NOTE: the version of the manual on the web may be older or newer
|
|
than the version of the program you're using. To ensure you're
|
|
reading the correct version, open the manual from within SourceGen,
|
|
using the <samp>Help > Help</samp> menu item or by hitting
|
|
<kbd class="key">F1</kbd>.
|
|
</p>
|
|
</div>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="intro.html">Overview</a>
|
|
<ul>
|
|
<li><a href="intro.html#fundamental-concepts">Fundamentals</a>
|
|
<ul>
|
|
<li><a href="intro.html#begin">About 6502 Code</a>
|
|
<li><a href="intro.html#charenc">Character Encoding</a></li>
|
|
<li><a href="intro.html#sgconcepts">SourceGen Concepts</a></li>
|
|
</ul></li>
|
|
<li><a href="intro.html#sgintro">How SourceGen Works</a></li>
|
|
</ul></li>
|
|
<li><a href="intro-details.html">Digging Deeper</a>
|
|
<ul>
|
|
<li><a href="intro-details.html#about-symbols">All About Symbols</a>
|
|
<ul>
|
|
<li><a href="intro-details.html#connecting-operands">Connecting Operands With Labels</a></li>
|
|
<li><a href="intro-details.html#internal-address-symbols">Internal Address Symbols</a></li>
|
|
<li><a href="intro-details.html#external-address-symbols">External Address Symbols</a></li>
|
|
<li><a href="intro-details.html#unique-local-global">Unique vs. Non-Unique and Local vs. Global</a></li>
|
|
<li><a href="intro-details.html#weak-refs">Weak Symbolic References</a></li>
|
|
<li><a href="intro-details.html#symbol-parts">Parts and Adjustments</a></li>
|
|
<li><a href="intro-details.html#nearby-targets">Automatic Use of Nearby Targets</a></li>
|
|
</ul></li>
|
|
<li><a href="intro-details.html#width-disambiguation">Width Disambiguation</a></li>
|
|
<li><a href="intro-details.html#address-regions">Address Regions</a>
|
|
<ul>
|
|
<li><a href="intro-details.html#fixed-float">Fixed vs. Floating</a></li>
|
|
<li><a href="intro-details.html#region-isolation">Isolation</a></li>
|
|
<li><a href="intro-details.html#non-addr">Non-Addressable Areas</a></li>
|
|
<li><a href="intro-details.html#pre-labels">Pre-Labels</a></li>
|
|
<li><a href="intro-details.html#relative-addr">Relative Addressing</a></li>
|
|
</ul></li>
|
|
<li><a href="intro-details.html#atags">Directing the Code Analyzer</a>
|
|
<ul>
|
|
<li><a href="intro-details.html#scripts">Extension Scripts</a></li>
|
|
</ul></li>
|
|
<li><a href="intro-details.html#embedded-instructions">Handling Embedded Instructions</a></li>
|
|
<li><a href="intro-details.html#pseudo-ops">Data and Directive Pseudo-Opcodes</a></li>
|
|
</ul></li>
|
|
|
|
<li><a href="mainwin.html">Using SourceGen</a>
|
|
<ul>
|
|
<li><a href="mainwin.html#starting-new">Starting a New Project</a></li>
|
|
<li><a href="mainwin.html#opening">Opening an Existing Project</a></li>
|
|
<li><a href="mainwin.html#saving">Saving a Project</a></li>
|
|
<li><a href="mainwin.html#working">Working With a Project</a>
|
|
<ul>
|
|
<li><a href="mainwin.html#code-list">Code List</a></li>
|
|
<li><a href="mainwin.html#undo">Undo & Redo</a></li>
|
|
<li><a href="mainwin.html#references">References Window</a></li>
|
|
<li><a href="mainwin.html#notes">Notes Window</a></li>
|
|
<li><a href="mainwin.html#symbols">Symbols Window</a></li>
|
|
<li><a href="mainwin.html#info">Info Window</a></li>
|
|
<li><a href="mainwin.html#messages">Messages Window</a></li>
|
|
<li><a href="mainwin.html#navigation">Navigation</a></li>
|
|
<li><a href="mainwin.html#atags">Adding and Removing Analyzer Tags</a></li>
|
|
<li><a href="mainwin.html#address-table">Format Address Table</a></li>
|
|
<li><a href="mainwin.html#toggle-single">Toggle Single-Byte Format</a></li>
|
|
<li><a href="mainwin.html#format-as-word">Format As Word</a></li>
|
|
<li><a href="mainwin.html#toggle-data">Toggle Data Scan</a></li>
|
|
<li><a href="mainwin.html#clipboard">Copying to Clipboard</a></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
|
|
<li><a href="editors.html">Editors</a>
|
|
<ul>
|
|
<li><a href="editors.html#address">Create/Edit Address Region</a></li>
|
|
<li><a href="editors.html#flags">Override Status Flags</a></li>
|
|
<li><a href="editors.html#label">Edit Label</a></li>
|
|
<li><a href="editors.html#instruction-operand">Edit Operand (Instruction)</a>
|
|
<ul>
|
|
<li><a href="editors.html#explicit-format">Explicit Formats</a></li>
|
|
<li><a href="editors.html#shortcut-nar">Numeric Address References</a></li>
|
|
<li><a href="editors.html#shortcut-local-var">Local Variable References</a></li>
|
|
</ul></li>
|
|
<li><a href="editors.html#data-operand">Edit Operand (Data)</a></li>
|
|
<li><a href="editors.html#operand-target-label">Edit Operand Target Label</a></li>
|
|
<li><a href="editors.html#comment">Edit Comment</a></li>
|
|
<li><a href="editors.html#long-comment">Edit Long Comment</a></li>
|
|
<li><a href="editors.html#data-bank">Edit Data Bank (65816 only)</a></li>
|
|
<li><a href="editors.html#note">Edit Note</a></li>
|
|
<li><a href="editors.html#project-symbol">Edit Project Symbol</a></li>
|
|
<li><a href="editors.html#lvtable">Create / Edit Local Variable Table</a></li>
|
|
</ul></li>
|
|
|
|
<li><a href="visualization.html">Visualizations</a>
|
|
<ul>
|
|
<li><a href="visualization.html#overview">Overview</a></li>
|
|
<li><a href="visualization.html#vis-and-sets">Visualizations and Visualization Sets</a></li>
|
|
<li><a href="visualization.html#runtime">Scripts Included with SourceGen</a></li>
|
|
</ul></li>
|
|
|
|
<li><a href="codegen.html">Code Generation & Assembly</a>
|
|
<ul>
|
|
<li><a href="codegen.html#generate">Generating Source Code</a>
|
|
<ul>
|
|
<li><a href="codegen.html#localizer">Label Localizer</a></li>
|
|
<li><a href="codegen.html#reserved-labels">Reserved Label Names</a></li>
|
|
<li><a href="codegen.html#platform-features">Platform-Specific Features</a></li>
|
|
</ul></li>
|
|
<li><a href="codegen.html#assemble">Cross-Assembling Generated Code</a></li>
|
|
<li><a href="codegen.html#supported">Supported Assemblers</a>
|
|
<ul>
|
|
<li><a href="codegen.html#version">Version-Specific Code Generation</a></li>
|
|
<li><a href="codegen.html#quirks">Assembler-Specific Bugs & Quirks</a>
|
|
<ul>
|
|
<li><a href="codegen.html#64tass">64tass</a></li>
|
|
<li><a href="codegen.html#acme">ACME</a></li>
|
|
<li><a href="codegen.html#cc65">cc65</a></li>
|
|
<li><a href="codegen.html#merlin32">Merlin 32</a></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
<li><a href="codegen.html#export-source">Exporting Source Code</a>
|
|
<li><a href="codegen.html#generate-labels">Generating Label Files</a>
|
|
</ul></li>
|
|
|
|
<li><a href="settings.html">Properties & Settings</a>
|
|
<ul>
|
|
<li><a href="settings.html#app-settings">Application Settings</a>
|
|
<ul>
|
|
<li><a href="settings.html#appset-codeview">Code View</a></li>
|
|
<li><a href="settings.html#appset-textdelim">Text Delimiters</a></li>
|
|
<li><a href="settings.html#appset-displayformat">Display Format</a></li>
|
|
<li><a href="settings.html#appset-pseudoop">Pseudo-Op</a></li>
|
|
<li><a href="settings.html#appset-asmconfig">Asm Config</a></li>
|
|
</ul></li>
|
|
<li><a href="settings.html#project-properties">Project Properties</a>
|
|
<ul>
|
|
<li><a href="settings.html#projprop-general">General</a></li>
|
|
<li><a href="settings.html#projprop-projsym">Project Symbols</a></li>
|
|
<li><a href="settings.html#projprop-symfiles">Symbol Files</a></li>
|
|
<li><a href="settings.html#projprop-extscripts">Extension Scripts</a></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
|
|
<li><a href="tools.html">Tools</a>
|
|
<ul>
|
|
<li><a href="tools.html#instruction-chart">Instruction Chart</a></li>
|
|
<li><a href="tools.html#ascii-chart">ASCII Chart</a></li>
|
|
<li><a href="tools.html#apple2-screen-chart">Apple II Screen Chart</a></li>
|
|
<li><a href="tools.html#hexdump">Hex Dump Viewer</a></li>
|
|
<li><a href="tools.html#file-concat">File Concatenator</a></li>
|
|
<li><a href="tools.html#file-slicer">File Slicer</a></li>
|
|
<li><a href="tools.html#omf-converter">OMF Converter</a></li>
|
|
</ul></li>
|
|
|
|
<li><a href="advanced.html">Advanced Topics</a>
|
|
<ul>
|
|
<li><a href="advanced.html#platform-symbols">Platform Symbol Files (.sym65)</a></li>
|
|
<li><a href="advanced.html#extension-scripts">Extension Scripts</a>
|
|
<ul>
|
|
<li><a href="advanced.html#built-in">Built-In Scripts</a>
|
|
<li><a href="advanced.html#script-dev">Script Development</a>
|
|
</ul></li>
|
|
<li><a href="advanced.html#multi-bin">Working With Multiple Binaries</a></li>
|
|
<li><a href="advanced.html#overlap">Overlapping Address Spaces</a></li>
|
|
<li><a href="advanced.html#reloc-data">OMF Relocation Dictionaries</a></li>
|
|
<li><a href="advanced.html#debug">Debug Menu Options</a></li>
|
|
</ul></li>
|
|
|
|
<li><a href="analysis.html">Appendix: Instruction and Data Analysis</a>
|
|
<ul>
|
|
<li><a href="analysis.html#analysis-process">Analysis Process</a>
|
|
<ul>
|
|
<li><a href="analysis.html#auto-format">Automatic Formatting</a></li>
|
|
<li><a href="analysis.html#undo-redo">Interaction With Undo/Redo</a></li>
|
|
</ul></li>
|
|
<li><a href="analysis.html#code-analysis">Code Analysis</a>
|
|
<ul>
|
|
<li><a href="analysis.html#extension-scripts">Extension Scripts</a></li>
|
|
</ul></li>
|
|
<li><a href="analysis.html#data-analysis">Data Analysis</a></li>
|
|
</ul></li>
|
|
|
|
<li><a href="end-notes.html">End Notes</a></li>
|
|
|
|
<!--
|
|
<li><a href="tutorials.html">Tutorials</a>
|
|
<ul>
|
|
<li><a href="tutorials.html#basic-features">Tutorial #1: Basic Features</a></li>
|
|
<li><a href="tutorials.html#advanced-features">Tutorial #2: Advanced Features</a></li>
|
|
<li><a href="tutorials.html#address-tables">Tutorial #3: Address Table Formatting</a></li>
|
|
<li><a href="tutorials.html#extension-scripts">Tutorial #4: Extension Scripts</a></li>
|
|
<li><a href="tutorials.html#visualizations">Tutorial #5: Visualizations</a></li>
|
|
</ul></li>
|
|
-->
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
<hr/>
|
|
<p>Copyright 2020 faddenSoft</p>
|
|
</div>
|
|
|
|
<script>
|
|
// Show a warning when reading the manual on the web (rather than
|
|
// from a file in the SourceGen installation directory).
|
|
var proto = window.location.protocol;
|
|
console.log(proto);
|
|
if (proto == "http:" || proto == "https:") {
|
|
document.getElementById("webwarn").style.display = "block";
|
|
}
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|