diff docs/manual/x170.html @ 231:2cc599f1bebf

Added --define to lwasm documentation. Added documentation of the -D/--define command line option for lwasm. It has been present for a long time but has somehow escaped documentation.
author William Astle <lost@l-w.ca>
date Sun, 15 Jul 2012 23:12:09 -0600
parents 83b7b4ce3bbd
children
line wrap: on
line diff
--- a/docs/manual/x170.html	Sun Jul 15 21:52:24 2012 -0600
+++ b/docs/manual/x170.html	Sun Jul 15 23:12:09 2012 -0600
@@ -2,7 +2,7 @@
 <HTML
 ><HEAD
 ><TITLE
->Source Format</TITLE
+>Dialects</TITLE
 ><META
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
@@ -13,11 +13,11 @@
 TITLE="LWASM"
 HREF="c45.html"><LINK
 REL="PREVIOUS"
-TITLE="Dialects"
-HREF="x163.html"><LINK
+TITLE="LWASM"
+HREF="c45.html"><LINK
 REL="NEXT"
-TITLE="Symbols"
-HREF="x180.html"></HEAD
+TITLE="Source Format"
+HREF="x177.html"></HEAD
 ><BODY
 CLASS="SECTION"
 BGCOLOR="#FFFFFF"
@@ -45,7 +45,7 @@
 ALIGN="left"
 VALIGN="bottom"
 ><A
-HREF="x163.html"
+HREF="c45.html"
 ACCESSKEY="P"
 >Prev</A
 ></TD
@@ -59,7 +59,7 @@
 ALIGN="right"
 VALIGN="bottom"
 ><A
-HREF="x180.html"
+HREF="x177.html"
 ACCESSKEY="N"
 >Next</A
 ></TD
@@ -74,45 +74,33 @@
 CLASS="SECTION"
 ><A
 NAME="AEN170"
->3.3. Source Format</A
+>3.2. Dialects</A
 ></H1
 ><P
->LWASM accepts plain text files in a relatively free form. It can handle
-lines terminated with CR, LF, CRLF, or LFCR which means it should be able
-to assemble files on any platform on which it compiles.</P
-><P
->Each line may start with a symbol. If a symbol is present, there must not
-be any whitespace preceding it. It is legal for a line to contain nothing
-but a symbol.</P
-><P
->The op code is separated from the symbol by whitespace. If there is
-no symbol, there must be at least one white space character preceding it.
-If applicable, the operand follows separated by whitespace. Following the
-opcode and operand is an optional comment.</P
+>LWASM supports all documented MC6809 instructions as defined by Motorola. 
+It also supports all known HD6309 instructions.  While there is general
+agreement on the pneumonics for most of the 6309 instructions, there is some
+variance with the block transfer instructions. TFM for all four variations
+seems to have gained the most traction and, thus, this is the form that is
+recommended for LWASM. However, it also supports COPY, COPY-, IMP, EXP,
+TFRP, TFRM, TFRS, and TFRR. It further adds COPY+ as a synomym for COPY,
+IMPLODE for IMP, and EXPAND for EXP.</P
 ><P
-> It is important to note that operands cannot contain any whitespace
-except in the case of delimited strings.  This is because the first
-whitespace character will be interpreted as the separator between the
-operand column and the comment.  This behaviour is required for approximate
-source compatibility with other 6x09 assemblers.  </P
-><P
->A comment can also be introduced with a * or a ;. The comment character is
-optional for end of statement comments. However, if a symbol is the only
-thing present on the line other than the comment, the comment character is
-mandatory to prevent the assembler from interpreting the comment as an opcode.</P
+>By default, LWASM accepts 6309 instructions. However, using the
+<CODE
+CLASS="PARAMETER"
+>--6809</CODE
+> parameter, you can cause it to throw errors on
+6309 instructions instead.</P
 ><P
->For compatibility with the output generated by some C preprocessors, LWASM
-will also ignore lines that begin with a #. This should not be used as a general
-comment character, however.</P
+>The standard addressing mode specifiers are supported. These are the
+hash sign ("#") for immediate mode, the less than sign ("&lt;") for forced
+eight bit modes, and the greater than sign ("&gt;") for forced sixteen bit modes.</P
 ><P
->The opcode is not treated case sensitively. Neither are register names in
-the operand fields. Symbols, however, are case sensitive.</P
-><P
-> As of version 2.6, LWASM supports files with line numbers.  If line
-numbers are present, the line must start with a digit.  The line number
-itself must consist only of digits.  The line number must then be followed
-by either the end of the line or exactly one white space character.  After
-that white space character, the lines are interpreted exactly as above. </P
+>Additionally, LWASM supports using the asterisk ("*") to indicate
+base page addressing. This should not be used in hand-written source code,
+however, because it is non-standard and may or may not be present in future
+versions of LWASM.</P
 ></DIV
 ><DIV
 CLASS="NAVFOOTER"
@@ -130,7 +118,7 @@
 ALIGN="left"
 VALIGN="top"
 ><A
-HREF="x163.html"
+HREF="c45.html"
 ACCESSKEY="P"
 >Prev</A
 ></TD
@@ -148,7 +136,7 @@
 ALIGN="right"
 VALIGN="top"
 ><A
-HREF="x180.html"
+HREF="x177.html"
 ACCESSKEY="N"
 >Next</A
 ></TD
@@ -158,7 +146,7 @@
 WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
->Dialects</TD
+>LWASM</TD
 ><TD
 WIDTH="34%"
 ALIGN="center"
@@ -172,7 +160,7 @@
 WIDTH="33%"
 ALIGN="right"
 VALIGN="top"
->Symbols</TD
+>Source Format</TD
 ></TR
 ></TABLE
 ></DIV