LWTools: docs/manual.docbook.sgml annotate

annotate docs/manual.docbook.sgml @ 364:44270b66df3c

Add some compatibility ops Add compatibility opcodes for other assemblers. Thanks to Erik G <erik@6809.org> for the patch.

author	William Astle <lost@l-w.ca>
date	Mon, 01 Jun 2015 19:55:11 -0600
parents	379ef4e08dd2
children	682524a1f32f

rev	line source
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.5//EN">
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2 <book>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	3 <bookinfo>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	4 <title>LW Tool Chain</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	5 <author><firstname>William</firstname><surname>Astle</surname></author>
324 b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	6 <author><firstname>LWTools Contributors</firstname><surname></surname></author>
348 379ef4e08dd2 Update copyright year for manual William Astle <lost@l-w.ca> parents: 347 diff changeset	7 <copyright><year>2009-2015</year><holder>William Astle and LWTools contributors</holder></copyright>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	8 </bookinfo>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	9 <chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	10
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	11 <title>Introduction</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	12
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	13 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	14 The LW tool chain provides utilities for building binaries for MC6809 and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	15 HD6309 CPUs. The tool chain includes a cross-assembler and a cross-linker
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	16 which support several styles of output.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	17 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	18
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	19 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	20 <title>History</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	21 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	22 For a long time, I have had an interest in creating an operating system for
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	23 the Coco3. I finally started working on that project around the beginning of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	24 2006. I had a number of assemblers I could choose from. Eventually, I settled
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	25 on one and started tinkering. After a while, I realized that assembler was not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	26 going to be sufficient due to lack of macros and issues with forward references.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	27 Then I tried another which handled forward references correctly but still did
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	28 not support macros. I looked around at other assemblers and they all lacked
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	29 one feature or another that I really wanted for creating my operating system.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	30 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	31
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	32 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	33 The solution seemed clear at that point. I am a fair programmer so I figured
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	34 I could write an assembler that would do everything I wanted an assembler to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	35 do. Thus the LWASM probject was born. After more than two years of on and off
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	36 work, version 1.0 of LWASM was released in October of 2008.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	37 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	38
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	39 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	40 As the aforementioned operating system project progressed further, it became
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	41 clear that while assembling the whole project through a single file was doable,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	42 it was not practical. When I found myself playing some fancy games with macros
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	43 in a bid to simulate sections, I realized I needed a means of assembling
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	44 source files separately and linking them later. This spawned a major development
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	45 effort to add an object file support to LWASM. It also spawned the LWLINK
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	46 project to provide a means to actually link the files.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	47 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	48
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	49 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	50
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	51 </chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	52
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	53 <chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	54 <title>Output Formats</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	55
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	56 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	57 The LW tool chain supports multiple output formats. Each format has its
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	58 advantages and disadvantages. Each format is described below.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	59 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	60
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	61 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	62 <title>Raw Binaries</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	63 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	64 A raw binary is simply a string of bytes. There are no headers or other
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	65 niceties. Both LWLINK and LWASM support generating raw binaries. ORG directives
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	66 in the source code only serve to set the addresses that will be used for
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	67 symbols but otherwise have no direct impact on the resulting binary.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	68 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	69
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	70 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	71 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	72 <title>DECB Binaries</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	73
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	74 <para>A DECB binary is compatible with the LOADM command in Disk Extended
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	75 Color Basic on the CoCo. They are also compatible with CLOADM from Extended
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	76 Color Basic. These binaries include the load address of the binary as well
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	77 as encoding an execution address. These binaries may contain multiple loadable
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	78 sections, each of which has its own load address.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	79
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	80 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	81 Each binary starts with a preamble. Each preamble is five bytes long. The
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	82 first byte is zero. The next two bytes specify the number of bytes to load
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	83 and the last two bytes specify the address to load the bytes at. Then, a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	84 string of bytes follows. After this string of bytes, there may be another
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	85 preamble or a postamble. A postamble is also five bytes in length. The first
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	86 byte of the postamble is $FF, the next two are zero, and the last two are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	87 the execution address for the binary.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	88 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	89
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	90 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	91 Both LWASM and LWLINK can output this format.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	92 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	93 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	94
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	95 <section>
324 b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	96 <title>ASCII Hexadecimal</title>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	97
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	98 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	99 This human-readable ASCII hexadecimal format consists of CR+LF terminated
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	100 lines of ASCII text. Each line has the following structure: a zero-padded
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	101 four-digit ASCII hex address, a colon separator, and one or more zero-padded
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	102 two-digit hex values separated by commas. ASCII Hexadecimal format favors
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	103 paragraph-aligned addresses (i.e. a least significant address nybble value
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	104 of zero). During output, the number of hex values on each line are adjusted
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	105 to align the address of the next line on a paragraph boundary. The sequence
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	106 of addresses in the ASCII Hexadecimal file directly follows that of the source
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	107 file; multiple ORG directives in the source code may result in out-of-sequence
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	108 addresses in the ASCII Hexadecimal output.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	109 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	110
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	111 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	112 LWASM can output this format since version 4.10.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	113 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	114 </section>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	115
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	116 <section>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	117 <title>Motorola S-Record</title>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	118
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	119 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	120 This ASCII format consists of a series of CR+LF terminated "records" of ASCII
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	121 text. Each record has the following structure: a start-of-record character
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	122 "S", an ASCII record type digit (0-9), a two-digit ASCII hex byte count, a
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	123 four-digit ASCII hex address, an optional sequence of two-digit ASCII hex data
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	124 values, and a two-digit ASCII hex checksum. The LW tool chain issues only S0,
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	125 S1, S5 and S9 record types. S1 records are limited to maximum of 16 data bytes
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	126 in length, and paragraph alignment of addresses is favored. The address
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	127 sequence of the S-Records directly follows that of the source file; multiple
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	128 ORG directives in the source code may result in out-of-sequence addresses in
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	129 the S-Record output.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	130 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	131
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	132 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	133 Motorola S-Record format is a standard ASCII format accepted by most memory
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	134 device programming equipment. It is particularly useful when the assembled
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	135 code output is destined to reside within an EPROM or Flash memory device,
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	136 for example.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	137 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	138
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	139 <para>
345 e95f07cbce4e Update manual to reflect lwlink support for S-record output William Astle <lost@l-w.ca> parents: 333 diff changeset	140 LWASM can output this format since version 4.10. LWLINK can output this format
e95f07cbce4e Update manual to reflect lwlink support for S-record output William Astle <lost@l-w.ca> parents: 333 diff changeset	141 since version 4.11.
324 b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	142 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	143 </section>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	144
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	145 <section>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	146 <title>Intel Hex</title>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	147
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	148 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	149 This ASCII format consists of a series of CR+LF terminated "records" of ASCII
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	150 text. Each record has the following structure: a start-of-record character
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	151 ":", a two-digit ASCII hex byte count, a four-digit ASCII hex address, a two-
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	152 digit ASCII hex record type, an optional sequence of two-digit ASCII hex data
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	153 values, and a two-digit ASCII hex checksum. The LW tool chain issues only 00,
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	154 and 01 Intel Hex record types. Data records are limited to maximum of 16
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	155 data bytes in length, and paragraph alignment of addresses is favored. The
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	156 address sequence of the Intel hex records directly follows that of the source
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	157 file; multiple ORG directives in the source code may result in out-of-sequence
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	158 addresses in the Intel Hex output.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	159 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	160
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	161 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	162 Intel Hex format is the other standard ASCII format accepted by most memory
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	163 device programming equipment, it and the Motorola S-Record format are used for
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	164 similar purposes.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	165 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	166
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	167 <para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	168 LWASM can output this format since version 4.10.
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	169 </para>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	170 </section>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	171
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	172 <section>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	173 <title>OS9 Modules</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	174 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	175
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	176 Since version 2.5, LWASM is able to generate OS9 modules. The syntax is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	177 basically the same as for other assemblers. A module starts with the MOD
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	178 directive and ends with the EMOD directive. The OS9 directive is provided
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	179 as a shortcut for writing system calls.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	180
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	181 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	182
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	183 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	184
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	185 LWASM does NOT provide an OS9Defs file. You must provide your own. Also note
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	186 that the common practice of using "ifp1" around the inclusion of the OS9Defs
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	187 file is discouraged as it is pointless and can lead to unintentional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	188 problems and phasing errors. Because LWASM reads each file exactly once,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	189 there is no benefit to restricting the inclusion to the first assembly pass.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	190
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	191 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	192
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	193 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	194
143 42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	195 As of version 4.5, LWASM also implements the standard data/code address
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	196 streams for OS9 modules. That means that between MOD and EMOD, any RMB,
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	197 RMD, RMQ, or equivalent directives will move the data address ahead and
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	198 leave the code address unmodified. Outside of an actual module, both the
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	199 code and data addresses are moved ahead equally. That last bit is critical
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	200 to understand because it means any directives that follow an EMOD directive
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	201 may have different results than other assemblers.
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	202
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	203 </para>
143 42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	204 <para>
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	205
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	206 Additionally, within a module body, the ORG directive sets only the data
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	207 address, not the code address. However, outside a module body, ORG sets both
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	208 addresses.
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	209
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	210 </para>
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	211
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	212 <para>
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	213 Both code and data addresses are reset to 0 by the MOD directive.
42a7a16a058f Documented the addition of data/code address streams for OS9 modules. lost@l-w.ca parents: 120 diff changeset	214 </para>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	215
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	216 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	217
152 a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	218 As of version 4.5, LWLINK also supports creation of OS9 modules.
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	219
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	220 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	221 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	222
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	223 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	224 <title>Object Files</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	225 <para>LWASM supports generating a proprietary object file format which is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	226 described in <xref linkend="objchap">. LWLINK is then used to link these
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	227 object files into a final binary in any of LWLINK's supported binary
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	228 formats.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	229
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	230 <para>Object files also support the concept of sections which are not valid
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	231 for other output types. This allows related code from each object file
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	232 linked to be collapsed together in the final binary.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	233
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	234 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	235 Object files are very flexible in that they allow references that are not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	236 known at assembly time to be resolved at link time. However, because the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	237 addresses of such references are not known at assembly time, there is no way
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	238 for the assembler to deduce that an eight bit addressing mode is possible.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	239 That means the assember will default to using sixteen bit addressing
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	240 whenever an external or cross-section reference is used.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	241 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	242
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	243 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	244 As of LWASM 2.4, it is possible to force direct page addressing for an
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	245 external reference. Care must be taken to ensure the resulting addresses
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	246 are really in the direct page since the linker does not know what the direct
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	247 page is supposed to be and does not emit errors for byte overflows.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	248 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	249
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	250 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	251 It is also possible to use external references in an eight bit immediate
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	252 mode instruction. In this case, only the low order eight bits will be used.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	253 Again, no byte overflows will be flagged.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	254 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	255
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	256
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	257 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	258
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	259 </chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	260
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	261 <chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	262 <title>LWASM</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	263 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	264 The LWTOOLS assembler is called LWASM. This chapter documents the various
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	265 features of the assembler. It is not, however, a tutorial on 6x09 assembly
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	266 language programming.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	267 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	268
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	269 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	270 <title>Command Line Options</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	271 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	272 The binary for LWASM is called "lwasm". Note that the binary is in lower
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	273 case. lwasm takes the following command line arguments.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	274 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	275
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	276 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	277
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	278 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	279 <term><option>--6309</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	280 <term><option>-3</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	281 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	282 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	283 This will cause the assembler to accept the additional instructions available
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	284 on the 6309 processor. This is the default mode; this option is provided for
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	285 completeness and to override preset command arguments.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	286 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	287 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	288 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	289
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	290 <varlistentry>
333 507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	291 <term><option>--6800compat</option></term>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	292 <listitem>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	293 <para>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	294 This is equivalent to <option>--pragma=6800compat</option>.</para>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	295 <para>This will enable recognition of 6800 compatibility instructions.</para>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	296 </listitem>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	297 </varlistentry>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	298
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	299 <varlistentry>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	300 <term><option>--6809</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	301 <term><option>-9</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	302 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	303 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	304 This will cause the assembler to reject instructions that are only available
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	305 on the 6309 processor.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	306 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	307 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	308 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	309
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	310 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	311 <term><option>--decb</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	312 <term><option>-b</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	313 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	314 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	315 Select the DECB output format target. Equivalent to <option>--format=decb</option>.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	316 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	317 <para>While this is the default output format currently, it is not safe to rely
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	318 on that fact. Future versions may have different defaults. It is also trivial
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	319 to modify the source code to change the default. Thus, it is recommended to specify
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	320 this option if you need DECB output.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	321 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	322 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	323
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	324 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	325 <term><option>--format=type</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	326 <term><option>-f type</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	327 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	328 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	329 Select the output format. Valid values are <option>obj</option> for the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	330 object file target, <option>decb</option> for the DECB LOADM format,
324 b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	331 <option>os9</option> for creating OS9 modules, <option>raw</option> for
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	332 a raw binary, <option>hex</option> for ASCII hexadecminal format,
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	333 <option>srec</option> for Motorola S-Record format, and <option>ihex</option>
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	334 for Intel Hex format.
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	335 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	336 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	337 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	338
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	339 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	340 <term><option>--list[=file]</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	341 <term><option>-l[file]</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	342 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	343 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	344 Cause LWASM to generate a listing. If <option>file</option> is specified,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	345 the listing will go to that file. Otherwise it will go to the standard output
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	346 stream. By default, no listing is generated. Unless <option>--symbols</option>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	347 is specified, the list will not include the symbol table.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	348 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	349 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	350 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	351
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	352 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	353 <term><option>--symbols</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	354 <term><option>-s</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	355 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	356 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	357 Causes LWASM to generate a list of symbols when generating a listing.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	358 It has no effect unless a listing is being generated.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	359 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	360 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	361 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	362
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	363 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	364 <term><option>--obj</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	365 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	366 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	367 Select the proprietary object file format as the output target.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	368 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	369 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	370 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	371
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	372 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	373 <term><option>--output=FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	374 <term><option>-o FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	375 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	376 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	377 This option specifies the name of the output file. If not specified, the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	378 default is <option>a.out</option>.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	379 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	380 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	381 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	382
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	383 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	384 <term><option>--pragma=pragma</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	385 <term><option>-p pragma</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	386 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	387 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	388 Specify assembler pragmas. Multiple pragmas are separated by commas. The
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	389 pragmas accepted are the same as for the PRAGMA assembler directive described
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	390 below.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	391 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	392 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	393 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	394
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	395 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	396 <term><option>--raw</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	397 <term><option>-r</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	398 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	399 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	400 Select raw binary as the output target.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	401 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	402 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	403 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	404
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	405 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	406 <term><option>--includedir=path</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	407 <term><option>-I path</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	408 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	409 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	410 Add <option>path</option> to the end of the include path.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	411 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	412 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	413 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	414
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	415 <varlistentry>
231 2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	416 <term><option>--define=SYM[=VAL]</option></term>
245 0bc1c88fe776 Fix typo in documentation of lwasm --define switch. William Astle <lost@l-w.ca> parents: 236 diff changeset	417 <term><option>-D SYM[=VAL]</option></term>
231 2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	418 <listitem>
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	419 <para>
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	420 Pre-defines the symbol SYM as either the specified VAL. If VAL is omitted,
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	421 the symbol is defined as 1. The symbol will be defined as though it were
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	422 defined using the SET directive in the assembly source. That means it can
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	423 be overridden by a SET directive within the source code. Attempting to
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	424 redefine SYM using EQU will result in a multiply defined symbol error.
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	425 </para>
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	426 </listitem>
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	427 </varlistentry>
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	428
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	429
2cc599f1bebf Added --define to lwasm documentation. William Astle <lost@l-w.ca> parents: 210 diff changeset	430 <varlistentry>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	431 <term><option>--help</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	432 <term><option>-?</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	433 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	434 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	435 Present a help screen describing the command line options.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	436 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	437 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	438 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	439
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	440 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	441 <term><option>--usage</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	442 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	443 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	444 Provide a summary of the command line options.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	445 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	446 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	447 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	448
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	449 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	450 <term><option>--version</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	451 <term><option>-V</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	452 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	453 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	454 Display the software version.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	455 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	456 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	457 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	458
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	459 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	460 <term><option>--debug</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	461 <term><option>-d</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	462 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	463 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	464 Increase the debugging level. Only really useful to people hacking on the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	465 LWASM source code itself.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	466 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	467 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	468 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	469
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	470 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	471
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	472 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	473
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	474 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	475 <title>Dialects</title>
333 507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	476
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	477 <para> LWASM supports all documented MC6809 instructions as defined by
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	478 Motorola. By default, this does not include any MC6800 compatibility
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	479 instructions. As of LWASM 4.11, those compatibility instructions can be
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	480 enabled using the <parameter>--6800compat</parameter> option or the
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	481 <parameter>6800compat</parameter> pragma. It also supports all known HD6309
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	482 instructions. While there is general agreement on the pneumonics for most
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	483 of the 6309 instructions, there is some variance with the block transfer
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	484 instructions. TFM for all four variations seems to have gained the most
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	485 traction and, thus, this is the form that is recommended for LWASM.
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	486 However, it also supports COPY, COPY-, IMP, EXP, TFRP, TFRM, TFRS, and TFRR.
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	487 It further adds COPY+ as a synomym for COPY, IMPLODE for IMP, and EXPAND for
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	488 EXP. </para>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	489
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	490 <para>By default, LWASM accepts 6309 instructions. However, using the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	491 <parameter>--6809</parameter> parameter, you can cause it to throw errors on
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	492 6309 instructions instead.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	493
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	494 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	495 The standard addressing mode specifiers are supported. These are the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	496 hash sign ("#") for immediate mode, the less than sign ("<") for forced
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	497 eight bit modes, and the greater than sign (">") for forced sixteen bit modes.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	498 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	499
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	500 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	501 Additionally, LWASM supports using the asterisk ("*") to indicate
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	502 base page addressing. This should not be used in hand-written source code,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	503 however, because it is non-standard and may or may not be present in future
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	504 versions of LWASM.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	505 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	506
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	507 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	508
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	509 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	510 <title>Source Format</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	511
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	512 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	513 LWASM accepts plain text files in a relatively free form. It can handle
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	514 lines terminated with CR, LF, CRLF, or LFCR which means it should be able
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	515 to assemble files on any platform on which it compiles.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	516 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	517 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	518 Each line may start with a symbol. If a symbol is present, there must not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	519 be any whitespace preceding it. It is legal for a line to contain nothing
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	520 but a symbol.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	521 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	522 The op code is separated from the symbol by whitespace. If there is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	523 no symbol, there must be at least one white space character preceding it.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	524 If applicable, the operand follows separated by whitespace. Following the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	525 opcode and operand is an optional comment.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	526 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	527
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	528 <para> It is important to note that operands cannot contain any whitespace
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	529 except in the case of delimited strings. This is because the first
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	530 whitespace character will be interpreted as the separator between the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	531 operand column and the comment. This behaviour is required for approximate
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	532 source compatibility with other 6x09 assemblers. </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	533
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	534 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	535 A comment can also be introduced with a * or a ;. The comment character is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	536 optional for end of statement comments. However, if a symbol is the only
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	537 thing present on the line other than the comment, the comment character is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	538 mandatory to prevent the assembler from interpreting the comment as an opcode.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	539 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	540
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	541 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	542 For compatibility with the output generated by some C preprocessors, LWASM
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	543 will also ignore lines that begin with a #. This should not be used as a general
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	544 comment character, however.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	545 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	546
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	547 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	548 The opcode is not treated case sensitively. Neither are register names in
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	549 the operand fields. Symbols, however, are case sensitive.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	550 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	551
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	552 <para> As of version 2.6, LWASM supports files with line numbers. If line
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	553 numbers are present, the line must start with a digit. The line number
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	554 itself must consist only of digits. The line number must then be followed
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	555 by either the end of the line or exactly one white space character. After
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	556 that white space character, the lines are interpreted exactly as above.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	557 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	558
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	559 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	560
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	561 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	562 <title>Symbols</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	563
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	564 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	565 Symbols have no length restriction. They may contain letters, numbers, dots,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	566 dollar signs, and underscores. They must start with a letter, dot, or
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	567 underscore.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	568 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	569
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	570 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	571 LWASM also supports the concept of a local symbol. A local symbol is one
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	572 which contains either a "?" or a "@", which can appear anywhere in the symbol.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	573 The scope of a local symbol is determined by a number of factors. First,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	574 each included file gets its own local symbol scope. A blank line will also
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	575 be considered a local scope barrier. Macros each have their own local symbol
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	576 scope as well (which has a side effect that you cannot use a local symbol
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	577 as an argument to a macro). There are other factors as well. In general,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	578 a local symbol is restricted to the block of code it is defined within.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	579 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	580
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	581 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	582 By default, unless assembling to the os9 target, a "$" in the symbol will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	583 also make it local. This can be controlled by the "dollarlocal" and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	584 "nodollarlocal" pragmas. In the absence of a pragma to the contrary, for
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	585 the os9 target, a "$" in the symbol will not make it considered local while
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	586 for all other targets it will.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	587 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	588
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	589 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	590
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	591 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	592 <title>Numbers and Expressions</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	593 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	594
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	595 Numbers can be expressed in binary, octal, decimal, or hexadecimal. Binary
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	596 numbers may be prefixed with a "%" symbol or suffixed with a "b" or "B".
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	597 Octal numbers may be prefixed with "@" or suffixed with "Q", "q", "O", or
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	598 "o". Hexadecimal numbers may be prefixed with "$", "0x" or "0X", or suffixed
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	599 with "H". No prefix or suffix is required for decimal numbers but they can
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	600 be prefixed with "&" if desired. Any constant which begins with a letter
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	601 must be expressed with the correct prefix base identifier or be prefixed
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	602 with a 0. Thus hexadecimal FF would have to be written either 0FFH or $FF.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	603 Numbers are not case sensitive.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	604
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	605 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	606
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	607 <para> A symbol may appear at any point where a number is acceptable. The
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	608 special symbol "*" can be used to represent the starting address of the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	609 current source line within expressions. </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	610
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	611 <para>The ASCII value of a character can be included by prefixing it with a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	612 single quote ('). The ASCII values of two characters can be included by
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	613 prefixing the characters with a quote (").</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	614
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	615 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	616
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	617 LWASM supports the following basic binary operators: +, -, *, /, and %.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	618 These represent addition, subtraction, multiplication, division, and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	619 modulus. It also supports unary negation and unary 1's complement (- and ^
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	620 respectively). It is also possible to use ~ for the unary 1's complement
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	621 operator. For completeness, a unary positive (+) is supported though it is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	622 a no-op. LWASM also supports using \|, &, and ^ for bitwise or, bitwise and,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	623 and bitwise exclusive or respectively.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	624
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	625 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	626
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	627 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	628
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	629 Operator precedence follows the usual rules. Multiplication, division, and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	630 modulus take precedence over addition and subtraction. Unary operators take
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	631 precedence over binary operators. Bitwise operators are lower precdence
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	632 than addition and subtraction. To force a specific order of evaluation,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	633 parentheses can be used in the usual manner.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	634
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	635 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	636
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	637 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	638
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	639 As of LWASM 2.5, the operators && and \|\| are recognized for boolean and and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	640 boolean or respectively. They will return either 0 or 1 (false or true).
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	641 They have the lowest precedence of all the binary operators.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	642
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	643 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	644
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	645 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	646
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	647 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	648 <title>Assembler Directives</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	649 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	650 Various directives can be used to control the behaviour of the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	651 assembler or to include non-code/data in the resulting output. Those directives
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	652 that are not described in detail in other sections of this document are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	653 described below.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	654 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	655
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	656 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	657 <title>Data Directives</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	658 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	659 <varlistentry><term>FCB <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	660 <term>.DB <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	661 <term>.BYTE <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	662 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	663 <para>Include one or more constant bytes (separated by commas) in the output.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	664 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	665 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	666
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	667 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	668 <term>FDB <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	669 <term>.DW <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	670 <term>.WORD <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	671 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	672 <para>Include one or more words (separated by commas) in the output.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	673 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	674 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	675
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	676 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	677 <term>FQB <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	678 <term>.QUAD <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	679 <term>.4BYTE <parameter>expr[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	680 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	681 <para>Include one or more double words (separated by commas) in the output.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	682 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	683 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	684
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	685 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	686 <term>FCC <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	687 <term>.ASCII <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	688 <term>.STR <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	689 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	690 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	691 Include a string of text in the output. The first character of the operand
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	692 is the delimiter which must appear as the last character and cannot appear
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	693 within the string. The string is included with no modifications>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	694 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	695 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	696 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	697
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	698 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	699 <term>FCN <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	700 <term>.ASCIZ <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	701 <term>.STRZ <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	702 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	703 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	704 Include a NUL terminated string of text in the output. The first character of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	705 the operand is the delimiter which must appear as the last character and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	706 cannot appear within the string. A NUL byte is automatically appended to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	707 the string.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	708 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	709 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	710 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	711
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	712 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	713 <term>FCS <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	714 <term>.ASCIS <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	715 <term>.STRS <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	716 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	717 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	718 Include a string of text in the output with bit 7 of the final byte set. The
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	719 first character of the operand is the delimiter which must appear as the last
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	720 character and cannot appear within the string.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	721 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	722 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	723 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	724
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	725 <varlistentry><term>ZMB <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	726 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	727 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	728 Include a number of NUL bytes in the output. The number must be fully resolvable
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	729 during pass 1 of assembly so no forward or external references are permitted.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	730 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	731 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	732 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	733
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	734 <varlistentry><term>ZMD <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	735 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	736 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	737 Include a number of zero words in the output. The number must be fully
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	738 resolvable during pass 1 of assembly so no forward or external references are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	739 permitted.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	740 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	741 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	742 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	743
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	744 <varlistentry><term>ZMQ <parameter>expr<parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	745 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	746 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	747 Include a number of zero double-words in the output. The number must be fully
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	748 resolvable during pass 1 of assembly so no forward or external references are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	749 permitted.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	750 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	751 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	752 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	753
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	754 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	755 <term>RMB <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	756 <term>.BLKB <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	757 <term>.DS <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	758 <term>.RS <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	759 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	760 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	761 Reserve a number of bytes in the output. The number must be fully resolvable
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	762 during pass 1 of assembly so no forward or external references are permitted.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	763 The value of the bytes is undefined.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	764 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	765 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	766 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	767
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	768 <varlistentry><term>RMD <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	769 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	770 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	771 Reserve a number of words in the output. The number must be fully
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	772 resolvable during pass 1 of assembly so no forward or external references are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	773 permitted. The value of the words is undefined.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	774 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	775 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	776 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	777
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	778 <varlistentry><term>RMQ <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	779 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	780 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	781 Reserve a number of double-words in the output. The number must be fully
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	782 resolvable during pass 1 of assembly so no forward or external references are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	783 permitted. The value of the double-words is undefined.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	784 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	785 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	786 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	787
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	788 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	789 <term>INCLUDEBIN <parameter>filename</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	790 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	791 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	792 Treat the contents of <parameter>filename</parameter> as a string of bytes to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	793 be included literally at the current assembly point. This has the same effect
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	794 as converting the file contents to a series of FCB statements and including
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	795 those at the current assembly point.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	796 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	797
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	798 <para> If <parameter>filename</parameter> beings with a /, the file name
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	799 will be taken as absolute. Otherwise, the current directory will be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	800 searched followed by the search path in the order specified.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	801
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	802 <para> Please note that absolute path detection including drive letters will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	803 not function correctly on Windows platforms. Non-absolute inclusion will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	804 work, however.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	805
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	806 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	807 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	808
254 155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	809 <varlistentry>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	810 <term>FILL <parameter>size</parameter>,<parameter>byte</parameter></term>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	811 <listitem>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	812
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	813 <para>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	814 Insert <parameter>size</parameter> bytes of <parameter>byte</parameter>.
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	815 </para>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	816
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	817 </listitem>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	818 </varlistentry>
155799f6cfa5 Add documentation for the FILL pseudo operation William Astle <lost@l-w.ca> parents: 253 diff changeset	819
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	820 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	821
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	822 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	823
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	824 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	825 <title>Address Definition</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	826 <para>The directives in this section all control the addresses of symbols
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	827 or the assembly process itself.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	828
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	829 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	830 <varlistentry><term>ORG <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	831 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	832 <para>Set the assembly address. The address must be fully resolvable on the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	833 first pass so no external or forward references are permitted. ORG is not
324 b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	834 permitted within sections when outputting to object files. For target formats
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	835 that include address information (decb, hex, srec, and ihex), an ORG
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	836 directive will re-start the address sequence within the output. When using
b30091890d62 Add documentation of the new hex output formats. William Astle <lost@l-w.ca> parents: 316 diff changeset	837 the raw target format, ORG is used only to determine the addresses of symbols.
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	838 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	839 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	840 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	841
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	842 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	843 <term><parameter>sym</parameter> EQU <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	844 <term><parameter>sym</parameter> = <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	845 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	846 <para>Define the value of <parameter>sym</parameter> to be <parameter>expr</parameter>.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	847 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	848 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	849
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	850 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	851 <term><parameter>sym</parameter> SET <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	852 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	853 <para>Define the value of <parameter>sym</parameter> to be <parameter>expr</parameter>.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	854 Unlike EQU, SET permits symbols to be defined multiple times as long as SET
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	855 is used for all instances. Use of the symbol before the first SET statement
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	856 that sets its value is undefined.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	857 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	858 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	859
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	860 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	861 <term>SETDP <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	862 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	863 <para>Inform the assembler that it can assume the DP register contains
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	864 <parameter>expr</parameter>. This directive is only advice to the assembler
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	865 to determine whether an address is in the direct page and has no effect
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	866 on the contents of the DP register. The value must be fully resolved during
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	867 the first assembly pass because it affects the sizes of subsequent instructions.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	868 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	869 <para>This directive has no effect in the object file target.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	870 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	871 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	872 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	873
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	874 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	875 <term>ALIGN <parameter>expr</parameter>[,<parameter>value</parameter>]</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	876 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	877
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	878 <para>Force the current assembly address to be a multiple of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	879 <parameter>expr</parameter>. If <parameter>value</parameter> is not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	880 specified, a series of NUL bytes is output to force the alignment, if
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	881 required. Otherwise, the low order 8 bits of <parameter>value</parameter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	882 will be used as the fill. The alignment value must be fully resolved on the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	883 first pass because it affects the addresses of subsquent instructions.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	884 However, <parameter>value</parameter> may include forward references; as
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	885 long as it resolves to a constant for the second pass, the value will be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	886 accepted.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	887
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	888 <para>Unless <parameter>value</parameter> is specified as something like $12,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	889 this directive is not suitable for inclusion in the middle of actual code.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	890 The default padding value is $00 which is intended to be used within data
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	891 blocks. </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	892
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	893 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	894 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	895
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	896 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	897
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	898 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	899
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	900 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	901 <title>Conditional Assembly</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	902 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	903 Portions of the source code can be excluded or included based on conditions
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	904 known at assembly time. Conditionals can be nested arbitrarily deeply. The
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	905 directives associated with conditional assembly are described in this section.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	906 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	907 <para>All conditionals must be fully bracketed. That is, every conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	908 statement must eventually be followed by an ENDC at the same level of nesting.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	909 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	910 <para>Conditional expressions are only evaluated on the first assembly pass.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	911 It is not possible to game the assembly process by having a conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	912 change its value between assembly passes. Due to the underlying architecture
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	913 of LWASM, there is no possible utility to IFP1 and IFP2, nor can they, as of LWASM 3.0, actually
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	914 be implemented meaningfully. Thus there is not and never will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	915 be any equivalent of IFP1 or IFP2 as provided by other assemblers. Use of those opcodes
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	916 will throw a warning and be ignored.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	917
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	918 <para>It is important to note that if a conditional does not resolve to a constant
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	919 during the first parsing pass, an error will be thrown. This is unavoidable because the assembler
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	920 must make a decision about which source to include and which source to exclude at this stage.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	921 Thus, expressions that work normally elsewhere will not work for conditions.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	922
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	923 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	924 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	925 <term>IFEQ <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	926 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	927 <para>If <parameter>expr</parameter> evaluates to zero, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	928 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	929 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	930 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	931 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	932
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	933 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	934 <term>IFNE <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	935 <term>IF <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	936 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	937 <para>If <parameter>expr</parameter> evaluates to a non-zero value, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	938 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	939 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	940 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	941 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	942
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	943 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	944 <term>IFGT <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	945 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	946 <para>If <parameter>expr</parameter> evaluates to a value greater than zero, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	947 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	948 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	949 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	950 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	951
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	952 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	953 <term>IFGE <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	954 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	955 <para>If <parameter>expr</parameter> evaluates to a value greater than or equal to zero, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	956 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	957 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	958 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	959 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	960
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	961 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	962 <term>IFLT <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	963 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	964 <para>If <parameter>expr</parameter> evaluates to a value less than zero, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	965 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	966 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	967 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	968 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	969
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	970 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	971 <term>IFLE <parameter>expr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	972 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	973 <para>If <parameter>expr</parameter> evaluates to a value less than or equal to zero , the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	974 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	975 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	976 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	977 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	978
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	979 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	980 <term>IFDEF <parameter>sym</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	981 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	982 <para>If <parameter>sym</parameter> is defined at this point in the assembly
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	983 process, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	984 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	985 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	986 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	987 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	988
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	989 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	990 <term>IFNDEF <parameter>sym</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	991 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	992 <para>If <parameter>sym</parameter> is not defined at this point in the assembly
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	993 process, the conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	994 will be considered true.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	995 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	996 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	997 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	998
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	999 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1000 <term>ELSE</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1001 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1002 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1003 If the preceding conditional at the same level of nesting was false, the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1004 statements following will be assembled. If the preceding conditional at
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1005 the same level was true, the statements following will not be assembled.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1006 Note that the preceding conditional might have been another ELSE statement
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1007 although this behaviour is not guaranteed to be supported in future versions
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1008 of LWASM.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1009 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1010 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1011
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1012 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1013 <term>ENDC</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1014 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1015 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1016 This directive marks the end of a conditional construct. Every conditional
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1017 construct must end with an ENDC directive.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1018 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1019 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1020 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1021
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1022 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1023 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1024
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1025 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1026 <title>OS9 Target Directives</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1027
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1028 <para>This section includes directives that apply solely to the OS9
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1029 target.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1030
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1031 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1032
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1033 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1034 <term>OS9 <parameter>syscall</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1035 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1036 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1037
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1038 This directive generates a call to the specified system call. <parameter>syscall</parameter> may be an arbitrary expression.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1039
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1040 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1041 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1042 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1043
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1044 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1045 <term>MOD <parameter>size</parameter>,<parameter>name</parameter>,<parameter>type</parameter>,<parameter>flags</parameter>,<parameter>execoff</parameter>,<parameter>datasize</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1046 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1047 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1048
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1049 This tells LWASM that the beginning of the actual module is here. It will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1050 generate a module header based on the parameters specified. It will also
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1051 begin calcuating the module CRC.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1052
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1053 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1054
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1055 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1056
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1057 The precise meaning of the various parameters is beyond the scope of this
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1058 document since it is not a tutorial on OS9 module programming.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1059
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1060 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1061
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1062 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1063 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1064
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1065 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1066 <term>EMOD</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1067 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1068 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1069
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1070 This marks the end of a module and causes LWASM to emit the calculated CRC
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1071 for the module.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1072
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1073 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1074 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1075
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1076 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1077 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1078
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1079 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1080 <title>Miscelaneous Directives</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1081
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1082 <para>This section includes directives that do not fit into the other
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1083 categories.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1084
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1085 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1086
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1087 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1088 <term>INCLUDE <parameter>filename</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1089 <term>USE <parameter>filename</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1090
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1091 <listitem> <para> Include the contents of <parameter>filename</parameter> at
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1092 this point in the assembly as though it were a part of the file currently
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1093 being processed. Note that if whitespace appears in the name of the file,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1094 you must enclose <parameter>filename</parameter> in quotes.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1095 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1096
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1097 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1098 Note that the USE variation is provided only for compatibility with other
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1099 assemblers. It is recommended to use the INCLUDE variation.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1100
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1101 <para>If <parameter>filename</parameter> begins with a "/", it is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1102 interpreted as an absolute path. If it does not, the search path will be used
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1103 to find the file. First, the directory containing the file that contains this
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1104 directive. (Includes within an included file are relative to the included file,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1105 not the file that included it.) If the file is not found there, the include path
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1106 is searched. If it is still not found, an error will be thrown. Note that the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1107 current directory as understood by your shell or operating system is not searched.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1108 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1109
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1110 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1111 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1112
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1113 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1114 <term>END <parameter>[expr]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1115 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1116 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1117 This directive causes the assembler to stop assembling immediately as though
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1118 it ran out of input. For the DECB target only, <parameter>expr</parameter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1119 can be used to set the execution address of the resulting binary. For all
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1120 other targets, specifying <parameter>expr</parameter> will cause an error.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1121 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1122 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1123 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1124
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1125 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1126 <term>ERROR <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1127 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1128 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1129 Causes a custom error message to be printed at this line. This will cause
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1130 assembly to fail. This directive is most useful inside conditional constructs
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1131 to cause assembly to fail if some condition that is known bad happens. Everything
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1132 from the directive to the end of the line is considered the error message.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1133 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1134 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1135 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1136
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1137 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1138 <term>WARNING <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1139 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1140 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1141 Causes a custom warning message to be printed at this line. This will not cause
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1142 assembly to fail. This directive is most useful inside conditional constructs
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1143 or include files to alert the programmer to a deprecated feature being used
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1144 or some other condition that may cause trouble later, but which may, in fact,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1145 not cause any trouble.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1146 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1147 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1148 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1149
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1150 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1151 <term>.MODULE <parameter>string</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1152 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1153 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1154 This directive is ignored for most output targets. If the output target
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1155 supports encoding a module name into it, <parameter>string</parameter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1156 will be used as the module name.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1157 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1158 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1159 As of version 3.0, no supported output targets support this directive.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1160 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1161 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1162 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1163
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1164 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1165 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1166
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1167 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1168
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1169 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1170 <title>Macros</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1171 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1172 LWASM is a macro assembler. A macro is simply a name that stands in for a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1173 series of instructions. Once a macro is defined, it is used like any other
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1174 assembler directive. Defining a macro can be considered equivalent to adding
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1175 additional assembler directives.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1176 </para>
60 9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1177
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1178 <para>Macros may accept parameters. These parameters are referenced within a
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1179 macro by the a backslash ("\") followed by a digit 1 through 9 for the first
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1180 through ninth parameters. They may also be referenced by enclosing the
60 9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1181 decimal parameter number in braces ("{num}"). The special expansion "\*"
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1182 translates to the exact parameter string, including all parameters, passed
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1183 to the macro. These parameter references are replaced with the verbatim text
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1184 of the parameter passed to the macro. A reference to a non-existent
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1185 parameter will be replaced by an empty string. Macro parameters are expanded
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1186 everywhere on each source line. That means the parameter to a macro could be
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1187 used as a symbol or it could even appear in a comment or could cause an
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1188 entire source line to be commented out when the macro is expanded. </para>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1189
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1190 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1191 Parameters passed to a macro are separated by commas and the parameter list
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1192 is terminated by any whitespace. This means that neither a comma nor whitespace
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1193 may be included in a macro parameter.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1194 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1195 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1196 Macro expansion is done recursively. That is, within a macro, macros are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1197 expanded. This can lead to infinite loops in macro expansion. If the assembler
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1198 hangs for a long time while assembling a file that uses macros, this may be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1199 the reason.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1200
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1201 <para>Each macro expansion receives its own local symbol context which is not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1202 inherited by any macros called by it nor is it inherited from the context
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1203 the macro was instantiated in. That means it is possible to use local symbols
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1204 within macros without having them collide with symbols in other macros or
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1205 outside the macro itself. However, this also means that using a local symbol
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1206 as a parameter to a macro, while legal, will not do what it would seem to do
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1207 as it will result in looking up the local symbol in the macro's symbol context
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1208 rather than the enclosing context where it came from, likely yielding either
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1209 an undefined symbol error or bizarre assembly results.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1210 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1211 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1212 Note that there is no way to define a macro as local to a symbol context. All
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1213 macros are part of the global macro namespace. However, macros have a separate
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1214 namespace from symbols so it is possible to have a symbol with the same name
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1215 as a macro.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1216 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1217
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1218 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1219 Macros are defined only during the first pass. Macro expansion also
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1220 only occurs during the first pass. On the second pass, the macro
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1221 definition is simply ignored. Macros must be defined before they are used.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1222 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1223
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1224 <para>The following directives are used when defining macros.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1225
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1226 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1227 <varlistentry>
51 fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1228 <term><parameter>macroname</parameter> MACRO [NOEXPAND]</term>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1229 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1230 <para>This directive is used to being the definition of a macro called
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1231 <parameter>macroname</parameter>. If <parameter>macroname</parameter> already
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1232 exists, it is considered an error. Attempting to define a macro within a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1233 macro is undefined. It may work and it may not so the behaviour should not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1234 be relied upon.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1235 </para>
51 fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1236
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1237 <para>If NOEXPAND is specified, the macro will not be expanded in a program
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1238 listing. Instead, all bytes emitted by all instructions within the macro
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1239 will appear to be emitted on the line where the macro is invoked, starting
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1240 at the address of the line of the invokation. If the macro uses ORG or other
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1241 directives that define symbols or change the assembly address, these things
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1242 will also be hidden (except in the symbol table) and the output bytes will
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1243 appear with incorrect address attribution. Thus, NOEXPAND should only be
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1244 used for macros that do not mess with the assembly address or otherwise
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1245 define symbols that should be visible.</para>
fd1ecc5d6e69 Added mention of NOEXPAND macro argument in manual lost@l-w.ca parents: 0 diff changeset	1246
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1247 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1248 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1249
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1250 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1251 <term>ENDM</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1252 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1253 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1254 This directive indicates the end of the macro currently being defined. It
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1255 causes the assembler to resume interpreting source lines as normal.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1256 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1257 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1258 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1259
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1260 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1261
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1262 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1263 <title>Structures</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1264 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1265
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1266 Structures are used to group related data in a fixed structure. A structure
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1267 consists a number of fields, defined in sequential order and which take up
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1268 specified size. The assembler does not enforce any means of access within a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1269 structure; it assumes that whatever you are doing, you intended to do.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1270 There are two pseudo ops that are used for defining structures.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1271
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1272 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1273
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1274 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1275 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1276 <term><parameter>structname</parameter> STRUCT</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1277 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1278 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1279
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1280 This directive is used to begin the definition of a structure with name
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1281 <parameter>structname</parameter>. Subsequent statements all form part of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1282 the structure definition until the end of the structure is declared.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1283
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1284 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1285 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1286 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1287 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1288 <term>ENDSTRUCT</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1289 <term>ENDS</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1290 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1291 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1292 This directive ends the definition of the structure. ENDSTRUCT is the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1293 preferred form. Prior to version 3.0 of LWASM, ENDS was used to end a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1294 section instead of a structure.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1295 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1296 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1297 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1298 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1299
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1300 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1301
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1302 Within a structure definition, only reservation pseudo ops are permitted.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1303 Anything else will cause an assembly error.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1304 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1305
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1306 <para> Once a structure is defined, you can reserve an area of memory in the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1307 same structure by using the structure name as the opcode. Structures can
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1308 also contain fields that are themselves structures. See the example
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1309 below.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1310
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1311 <programlisting>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1312 tstruct2 STRUCT
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1313 f1 rmb 1
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1314 f2 rmb 1
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1315 ENDSTRUCT
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1316
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1317 tstruct STRUCT
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1318 field1 rmb 2
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1319 field2 rmb 3
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1320 field3 tstruct2
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1321 ENDSTRUCT
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1322
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1323 ORG $2000
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1324 var1 tstruct
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1325 var2 tstruct2
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1326 </programlisting>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1327
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1328 <para>Fields are referenced using a dot (.) as a separator. To refer to the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1329 generic offset within a structure, use the structure name to the left of the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1330 dot. If referring to a field within an actual variable, use the variable's
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1331 symbol name to the left of the dot.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1332
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1333 <para>You can also refer to the actual size of a structure (or a variable
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1334 declared as a structure) using the special symbol sizeof{structname} where
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1335 structname will be the name of the structure or the name of the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1336 variable.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1337
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1338 <para>Essentially, structures are a shortcut for defining a vast number of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1339 symbols. When a structure is defined, the assembler creates symbols for the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1340 various fields in the form structname.fieldname as well as the appropriate
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1341 sizeof{structname} symbol. When a variable is declared as a structure, the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1342 assembler does the same thing using the name of the variable. You will see
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1343 these symbols in the symbol table when the assembler is instructed to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1344 provide a listing. For instance, the above listing will create the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1345 following symbols (symbol values in parentheses): tstruct2.f1 (0),
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1346 tstruct2.f2 (1), sizeof{tstruct2} (2), tstruct.field1 (0), tstruct.field2
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1347 (2), tstruct.field3 (5), tstruct.field3.f1 (5), tstruct.field3.f2 (6),
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1348 sizeof{tstruct.field3} (2), sizeof{tstruct} (7), var1 {$2000}, var1.field1
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1349 {$2000}, var1.field2 {$2002}, var1.field3 {$2005}, var1.field3.f1 {$2005},
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1350 var1.field3.f2 {$2006}, sizeof(var1.field3} (2), sizeof{var1} (7), var2
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1351 ($2007), var2.f1 ($2007), var2.f2 ($2008), sizeof{var2} (2). </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1352
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1353 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1354
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1355 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1356 <title>Object Files and Sections</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1357 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1358 The object file target is very useful for large project because it allows
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1359 multiple files to be assembled independently and then linked into the final
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1360 binary at a later time. It allows only the small portion of the project
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1361 that was modified to be re-assembled rather than requiring the entire set
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1362 of source code to be available to the assembler in a single assembly process.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1363 This can be particularly important if there are a large number of macros,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1364 symbol definitions, or other metadata that uses resources at assembly time.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1365 By far the largest benefit, however, is keeping the source files small enough
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1366 for a mere mortal to find things in them.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1367 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1368
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1369 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1370 With multi-file projects, there needs to be a means of resolving references to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1371 symbols in other source files. These are known as external references. The
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1372 addresses of these symbols cannot be known until the linker joins all the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1373 object files into a single binary. This means that the assembler must be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1374 able to output the object code without knowing the value of the symbol. This
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1375 places some restrictions on the code generated by the assembler. For
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1376 example, the assembler cannot generate direct page addressing for instructions
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1377 that reference external symbols because the address of the symbol may not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1378 be in the direct page. Similarly, relative branches and PC relative addressing
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1379 cannot be used in their eight bit forms. Everything that must be resolved
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1380 by the linker must be assembled to use the largest address size possible to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1381 allow the linker to fill in the correct value at link time. Note that the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1382 same problem applies to absolute address references as well, even those in
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1383 the same source file, because the address is not known until link time.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1384 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1385
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1386 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1387 It is often desired in multi-file projects to have code of various types grouped
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1388 together in the final binary generated by the linker as well. The same applies
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1389 to data. In order for the linker to do that, the bits that are to be grouped
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1390 must be tagged in some manner. This is where the concept of sections comes in.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1391 Each chunk of code or data is part of a section in the object file. Then,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1392 when the linker reads all the object files, it coalesces all sections of the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1393 same name into a single section and then considers it as a unit.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1394 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1395
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1396 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1397 The existence of sections, however, raises a problem for symbols even
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1398 within the same source file. Thus, the assembler must treat symbols from
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1399 different sections within the same source file in the same manner as external
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1400 symbols. That is, it must leave them for the linker to resolve at link time,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1401 with all the limitations that entails.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1402 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1403
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1404 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1405 In the object file target mode, LWASM requires all source lines that
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1406 cause bytes to be output to be inside a section. Any directives that do
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1407 not cause any bytes to be output can appear outside of a section. This includes
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1408 such things as EQU or RMB. Even ORG can appear outside a section. ORG, however,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1409 makes no sense within a section because it is the linker that determines
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1410 the starting address of the section's code, not the assembler.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1411 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1412
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1413 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1414 All symbols defined globally in the assembly process are local to the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1415 source file and cannot be exported. All symbols defined within a section are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1416 considered local to the source file unless otherwise explicitly exported.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1417 Symbols referenced from external source files must be declared external,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1418 either explicitly or by asking the assembler to assume that all undefined
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1419 symbols are external.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1420 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1421
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1422 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1423 It is often handy to define a number of memory addresses that will be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1424 used for data at run-time but which need not be included in the binary file.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1425 These memory addresses are not initialized until run-time, either by the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1426 program itself or by the program loader, depending on the operating environment.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1427 Such sections are often known as BSS sections. LWASM supports generating
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1428 sections with a BSS attribute set which causes the section definition including
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1429 symbols exported from that section and those symbols required to resolve
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1430 references from the local file, but with no actual code in the object file.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1431 It is illegal for any source lines within a BSS flagged section to cause any
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1432 bytes to be output.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1433 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1434
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1435 <para>The following directives apply to section handling.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1436
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1437 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1438 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1439 <term>SECTION <parameter>name[,flags]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1440 <term>SECT <parameter>name[,flags]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1441 <term>.AREA <parameter>name[,flags]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1442 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1443 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1444 Instructs the assembler that the code following this directive is to be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1445 considered part of the section <parameter>name</parameter>. A section name
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1446 may appear multiple times in which case it is as though all the code from
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1447 all the instances of that section appeared adjacent within the source file.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1448 However, <parameter>flags</parameter> may only be specified on the first
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1449 instance of the section.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1450 </para>
168 1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1451
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1452 <para><parameter>flags</parameter> is a comma separated list of flags. If a
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1453 flag is "bss", the section will be treated as a BSS section and no
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1454 statements that generate output are permitted.</para>
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1455
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1456 <para>If the flag is "constant",
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1457 the same restrictions apply as for BSS sections. Additionally, all symbols
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1458 defined in a constant section define absolute values and will not be
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1459 adjusted by the linker at link time. Constant sections cannot define
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1460 complex expressions for symbols; the value must be fully defined at assembly
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1461 time. Additionally, multiple instances of a constant section do not
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1462 coalesce into a single addressing unit; each instance starts again at offset
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1463 0.</para>
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1464
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1465 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1466 If the section name is "bss" or ".bss" in any combination of upper and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1467 lower case, the section is assumed to be a BSS section. In that case,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1468 the flag <parameter>!bss</parameter> can be used to override this assumption.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1469 </para>
168 1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1470
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1471 <para> If the section name is "_constants" or "_constant", in any
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1472 combination of upper and lower case, the section is assumed to be a constant
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1473 section. This assumption can be overridden with the "!constant"
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1474 flag.</para>
1e0a0e6cd918 Documentation updates lost@l-w.ca parents: 152 diff changeset	1475
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1476 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1477 If assembly is already happening within a section, the section is implicitly
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1478 ended and the new section started. This is not considered an error although
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1479 it is recommended that all sections be explicitly closed.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1480 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1481 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1482 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1483
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1484 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1485 <term>ENDSECTION</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1486 <term>ENDSECT</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1487 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1488 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1489 This directive ends the current section. This puts assembly outside of any
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1490 sections until the next SECTION directive. ENDSECTION is the preferred form.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1491 Prior to version 3.0 of LWASM, ENDS could also be used to end a section but
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1492 as of version 3.0, it is now an alias for ENDSTRUCT instead.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1493 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1494 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1495
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1496 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1497 <term><parameter>sym</parameter> EXTERN</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1498 <term><parameter>sym</parameter> EXTERNAL</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1499 <term><parameter>sym</parameter> IMPORT</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1500 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1501 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1502 This directive defines <parameter>sym</parameter> as an external symbol.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1503 This directive may occur at any point in the source code. EXTERN definitions
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1504 are resolved on the first pass so an EXTERN definition anywhere in the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1505 source file is valid for the entire file. The use of this directive is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1506 optional when the assembler is instructed to assume that all undefined
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1507 symbols are external. In fact, in that mode, if the symbol is referenced
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1508 before the EXTERN directive, an error will occur.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1509 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1510 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1511 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1512
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1513 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1514 <term><parameter>sym</parameter> EXPORT</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1515 <term><parameter>sym</parameter> .GLOBL</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1516
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1517 <term>EXPORT <parameter>sym</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1518 <term>.GLOBL <parameter>sym</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1519
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1520 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1521 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1522 This directive defines <parameter>sym</parameter> as an exported symbol.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1523 This directive may occur at any point in the source code, even before the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1524 definition of the exported symbol.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1525 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1526 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1527 Note that <parameter>sym</parameter> may appear as the operand or as the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1528 statement's symbol. If there is a symbol on the statement, that will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1529 take precedence over any operand that is present.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1530 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1531 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1532
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1533 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1534
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1535 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1536 <term><parameter>sym</parameter> EXTDEP</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1537 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1538
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1539 <para>This directive forces an external dependency on
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1540 <parameter>sym</parameter>, even if it is never referenced anywhere else in
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1541 this file.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1542
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1543 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1544 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1545 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1546
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1547 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1548
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1549 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1550 <title>Assembler Modes and Pragmas</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1551 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1552 There are a number of options that affect the way assembly is performed.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1553 Some of these options can only be specified on the command line because
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1554 they determine something absolute about the assembly process. These include
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1555 such things as the output target. Other things may be switchable during
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1556 the assembly process. These are known as pragmas and are, by definition,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1557 not portable between assemblers.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1558 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1559
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1560 <para>LWASM supports a number of pragmas that affect code generation or
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1561 otherwise affect the behaviour of the assembler. These may be specified by
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1562 way of a command line option or by assembler directives. The directives
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1563 are as follows.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1564 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1565
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1566 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1567 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1568 <term>PRAGMA <parameter>pragma[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1569 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1570 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1571 Specifies that the assembler should bring into force all <parameter>pragma</parameter>s
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1572 specified. Any unrecognized pragma will cause an assembly error. The new
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1573 pragmas will take effect immediately. This directive should be used when
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1574 the program will assemble incorrectly if the pragma is ignored or not supported.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1575 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1576 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1577 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1578
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1579 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1580 <term>*PRAGMA <parameter>pragma[,...]</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1581 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1582 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1583 This is identical to the PRAGMA directive except no error will occur with
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1584 unrecognized or unsupported pragmas. This directive, by virtue of starting
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1585 with a comment character, will also be ignored by assemblers that do not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1586 support this directive. Use this variation if the pragma is not required
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1587 for correct functioning of the code.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1588 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1589 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1590 </varlistentry>
111 c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1591
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1592 <varlistentry>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1593 <term>*PRAGMAPUSH <parameter>pragma[,...]</parameter></term>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1594 <listitem>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1595 <para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1596 This directive saves the current state of the specified pragma(s) for later retrieval. See discussion below for more information.
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1597 </para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1598
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1599 <para>This directive will not throw any errors for any reason.</para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1600
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1601 </listitem>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1602 </varlistentry>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1603
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1604 <varlistentry>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1605 <term>*PRAGMAPOP <parameter>pragma[,...]</parameter></term>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1606 <listitem>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1607 <para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1608 This directive restores the previously saved state of the specified pragma(s). See discussion below for more information.
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1609 </para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1610
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1611 <para>This directive will not throw any errors for any reason.</para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1612
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1613 </listitem>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1614 </varlistentry>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1615 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1616
207 07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1617 <para>Each pragma supported has a positive version and a negative version.
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1618 The positive version enables the pragma while the negative version disables
207 07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1619 it. The negatitve version is simply the positive version with "no" prefixed
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1620 to it. For instance, "pragma" vs. "nopragma". When only one version is
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1621 listed below, its opposite can be obtained by prepending "no" if it is not
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1622 present or removing "no" from the beginning if it is present.</para>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1623
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1624 <para>Pragmas are not case sensitive.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1625
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1626 <variablelist>
333 507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1627
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1628 <varlistentry>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1629 <term>6800compat</term>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1630 <listitem>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1631
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1632 <para>When in force, this pragma enables recognition of various
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1633 compatibility instructions useful when assembling 6800 code. These
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1634 compatibility instructions are assembled into equivalent 6809 instructions.
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1635 This mode also includes several analogous instructions which are not
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1636 strictly 6800 instructions but allow the similar style to be applied to 6809
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1637 specific features.</para>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1638
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1639 <para>Technically, a compliant 6809 assembler must recognize these
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1640 instructions by default since Motorola advertised the 6809 as being source
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1641 compatible with the 6800. However, most source code does not require this
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1642 compatibility and LWASM itself did not support these instructions prior to
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1643 version 4.11 so this mode is disabled by default.</para>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1644
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1645 </listitem>
507f442dc71e Add support for 6800 compatibility instructions. William Astle <lost@l-w.ca> parents: 324 diff changeset	1646
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1647 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1648 <term>index0tonone</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1649 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1650 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1651 When in force, this pragma enables an optimization affecting indexed addressing
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1652 modes. When the offset expression in an indexed mode evaluates to zero but is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1653 not explicity written as 0, this will replace the operand with the equivalent
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1654 no offset mode, thus creating slightly faster code. Because of the advantages
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1655 of this optimization, it is enabled by default.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1656 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1657 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1658 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1659
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1660 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1661 <term>cescapes</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1662 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1663 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1664 This pragma will cause strings in the FCC, FCS, and FCN pseudo operations to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1665 have C-style escape sequences interpreted. The one departure from the official
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1666 spec is that unrecognized escape sequences will return either the character
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1667 immediately following the backslash or some undefined value. Do not rely
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1668 on the behaviour of undefined escape sequences.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1669 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1670 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1671 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1672
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1673 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1674 <term>importundefexport</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1675 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1676 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1677 This pragma is only valid for targets that support external references. When
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1678 in force, it will cause the EXPORT directive to act as IMPORT if the symbol
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1679 to be exported is not defined. This is provided for compatibility with the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1680 output of gcc6809 and should not be used in hand written code. Because of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1681 the confusion this pragma can cause, it is disabled by default.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1682 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1683 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1684 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1685
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1686 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1687 <term>undefextern</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1688 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1689 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1690 This pragma is only valid for targets that support external references. When in
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1691 force, if the assembler sees an undefined symbol on the second pass, it will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1692 automatically define it as an external symbol. This automatic definition will
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1693 apply for the remainder of the assembly process, even if the pragma is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1694 subsequently turned off. Because this behaviour would be potentially surprising,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1695 this pragma defaults to off.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1696 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1697 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1698 The primary use for this pragma is for projects that share a large number of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1699 symbols between source files. In such cases, it is impractical to enumerate
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1700 all the external references in every source file. This allows the assembler
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1701 and linker to do the heavy lifting while not preventing a particular source
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1702 module from defining a local symbol of the same name as an external symbol
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1703 if it does not need the external symbol. (This pragma will not cause an
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1704 automatic external definition if there is already a locally defined symbol.)
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1705 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1706 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1707 This pragma will often be specified on the command line for large projects.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1708 However, depending on the specific dynamics of the project, it may be sufficient
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1709 for one or two files to use this pragma internally.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1710 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1711 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1712 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1713
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1714 <varlistentry>
253 ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1715 <term>export</term>
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1716 <listitem>
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1717
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1718 <para>This pragma causes all symbols to be added to the export list
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1719 automatically. This is useful when a large number of symbols need to be
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1720 exported but you do not wish to include an EXPORT directive for all of them.
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1721 This is often useful on the command line but might be useful even inline
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1722 with the PRAGMA directive if a large number of symbols in a row are to be
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1723 exported.</para>
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1724
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1725 </listitem>
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1726 </varlistentry>
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1727
ed1009bce533 Document the "export" pragma William Astle <lost@l-w.ca> parents: 245 diff changeset	1728 <varlistentry>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1729 <term>dollarlocal</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1730 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1731
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1732 <para>When set, a "$" in a symbol makes it local. When not set, "$" does not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1733 cause a symbol to be local. It is set by default except when using the OS9
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1734 target.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1735
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1736 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1737 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1738
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1739 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1740 <term>dollarnotlocal</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1741 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1742
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1743 <para> This is the same as the "dollarlocal" pragma except its sense is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1744 reversed. That is, "dollarlocal" and "nodollarnotlocal" are equivalent and
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1745 "nodollarlocal" and "dollarnotlocal" are equivalent. </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1746
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1747 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1748 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1749
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1750 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1751 <term>pcaspcr</term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1752 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1753
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1754 <para> Normally, LWASM makes a distinction between PC and PCR in program
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1755 counter relative addressing. In particular, the use of PC means an absolute
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1756 offset from PC while PCR causes the assembler to calculate the offset to the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1757 specified operand and use that as the offset from PC. By setting this
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1758 pragma, you can have PC treated the same as PCR. </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1759
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1760
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1761 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1762 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1763
60 9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1764 <varlistentry>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1765 <term>shadow</term>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1766 <listitem>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1767
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1768 <para>When this pragma is in effect, it becomes possible to define a macro
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1769 that matches an internal operation code. Thus, it makes it possible to
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1770 redefine either CPU instructions or pseudo operations. Because this feature
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1771 is of dubious utility, it is disabled by default.</para>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1772
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1773 </listitem>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1774 </varlistentry>
9ded7e6fc1b0 Updated documentation to include recently added features lost@l-w.ca parents: 51 diff changeset	1775
111 c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1776 <varlistentry>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1777 <term>nolist</term>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1778 <listitem>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1779
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1780 <para>Lines where this pragma is in effect will not appear in the assembly
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1781 listing. Also, any symbols defined under this pragma will not show up in
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1782 the symbol list. This is most useful in include files to avoid spamming the
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1783 assembly listing with dozens, hundreds, or thousands of irrelevant
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1784 symbols.</para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1785
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1786 </listitem>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1787 </varlistentry>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1788
117 8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1789 <varlistentry>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1790 <term>autobranchlength</term>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1791 <listitem>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1792
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1793 <para>One of the perennial annoyances for 6809 programmers is that the
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1794 mneumonics for the short and long branch instructions are different (bxx vs.
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1795 lbxx), which is at odds with the rest of the instruction set. This pragma
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1796 is a solution to those annoying byte overflow errors that short branch
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1797 instructions tend to aquire.</para>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1798
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1799 <para>When this pragma is in effect, which is not the default, whenever any
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1800 relative branch instruction is used, its size will be automatically
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1801 determined based on the actual distance to the destination. In other words,
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1802 one can write code with long or short branches everywhere and the assembler
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1803 will choose a size for the branch.</para>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1804
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1805 <para>Also, while this pragma is in effect, the > and < symbols can be used
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1806 to force the branch size, analogous to their use for other instructions with
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1807 < forcing 8 bit offsets and > forcing 16 bit offets.</para>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1808
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1809 <para>Because this pragma leads to source that is incompatible with other
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1810 assemblers, it is strongly recommended that it be invoked using the PRAGMA
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1811 directive within the source code rather than on the command line or via the
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1812 *PRAGMA directive. This way, an error will be raised if someone tries to
207 07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1813 assemble the code under a different assembler.</para>
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1814
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1815 <varlistentry>
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1816 <term>nosymbolcase</term>
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1817 <term>symbolnocase</term>
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1818 <listitem>
117 8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1819
207 07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1820 <para>Any symbol defined while this pragma is in force will be treated as
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1821 case insensitive, regardless whether the pragma is in force when the symbol
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1822 is referenced.</para>
117 8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1823
207 07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1824 <para>It is important to note that this pragma will not work as expected in
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1825 all cases when using the object file assembly target. It is intended for
07e1fac76321 Added pragma to allow non case sensitive symbols William Astle <lost@l-w.ca> parents: 168 diff changeset	1826 use only when the assembler will be producing the final binary.</para>
117 8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1827
210 5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1828 <varlistentry>
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1829 <term>condundefzero</term>
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1830 <listitem>
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1831
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1832 <para>This pragma will cause the assembler to change the way it handles
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1833 symbols in conditional expressions. Ordinarily, any symbol that is not
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1834 defined prior to the conditional will throw an undefined symbol error. With
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1835 this pragma in effect, symbols that are not yet defined at the point the
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1836 conditional is encountered will be treated as zero.</para>
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1837
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1838 <para>This is not the default because it encourages poor code design. One
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1839 should use the "IFDEF" or "IFNDEF" conditionals to test for the presence of
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1840 a symbol.</para>
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1841
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1842 <para>It is important to note that if a symbol is defined but it does not
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1843 yet evaluate to a constant value at the point where the conditional appears,
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1844 the assembler will still complain about a non constant condition.</para>
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1845
5d969517db74 Added condundefzero pragma William Astle <lost@l-w.ca> parents: 207 diff changeset	1846
117 8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1847 </listitem>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1848 </varlistentry>
8e2523061ce9 Document the new autobranchlength pragma lost@l-w.ca parents: 111 diff changeset	1849
347 330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1850 <varlistentry>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1851 <term>forwardrefmax</term>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1852 <listitem>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1853
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1854 <para>This pragma will disable forward reference optimization completely.
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1855 Ordinarily, LWASM will attempt to select the shortest possible addressing
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1856 mode for forward references. However, in many source files, especially
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1857 those not using the PCR relative addressing modes, this optimization is
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1858 pointless since the assembler will almost certainly settle on a 16 bit
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1859 offset or address. If all variables in the direct page are defined before
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1860 the main body of the code, the benefit of forward reference optimization
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1861 almost certainly vanishes completely. However, the cost of doing that
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1862 optimization remains and can result in a very long assembly time.</para>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1863
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1864 <para>Enabling this pragma will cause all forward references to use the
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1865 maximum offset or address size, much the same has EDTASM and other pure
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1866 two pass assemblers do. The side effect is that all line lengths and
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1867 symbol values are fully resolved after the initial parsing pass and the
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1868 amount of work to resolve everything becomes almost nil.</para>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1869
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1870 <para>While this pragma can be applied selectively to sections of source
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1871 code (use *PRAGMA if doing so and compatibility with other assemblers
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1872 is desired), it is likely more useful when provided as a command line
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1873 pragma.</para>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1874
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1875 <para>It should be noted that the presence or absence of this pragma
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1876 will not change the correctness of the generated code unless cycle counts
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1877 or byte counts are critical (which they usually are not). It also will
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1878 not override the operand size override prefixes (< and >). It only
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1879 applies when the assembler is left to guess what the operand size is.</para>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1880
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1881 </listitem>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1882 </varlistentry>
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1883
330a66a0f45a Document the forwardrefmax pragma William Astle <lost@l-w.ca> parents: 345 diff changeset	1884
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1885 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1886
111 c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1887 <para>As a convenience, each input file has a pragma state stack. This
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1888 allows, through the use of PRAGMAPUSH and PRAGMAPOP, a file to change a
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1889 pragma state and then restore it to the precise state it had previously.
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1890 If, at the end of an input file, all pragma states have not been popped,
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1891 they will be removed from the stack. Thus, it is critical to employ
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1892 *PRAGMAPOP correctly. Because each input file has its own pragma stack,
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1893 using PRAGMAPUSH in one file and PRAGMAPOP in another file will not
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1894 work.</para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1895
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1896 <para>Pragma stacks are more useful in include files, in particular in
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1897 conjunction with the nolist pragma. One can push the state of the nolist
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1898 pragma, engage the nolist pragma, and then pop the state of the nolist
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1899 pragma at the end of the include file. This will cause the entire include
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1900 file to operate under the nolist pragma. However, if the file is included
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1901 while nolist is already engaged, it will not undo that state.</para>
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1902
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1903
c0aedb1584af Updated manual to describe nolist pragma and pragma stacks lost@l-w.ca parents: 68 diff changeset	1904
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1905 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1906
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1907 </chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1908
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1909 <chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1910 <title>LWLINK</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1911 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1912 The LWTOOLS linker is called LWLINK. This chapter documents the various features
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1913 of the linker.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1914 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1915
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1916 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1917 <title>Command Line Options</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1918 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1919 The binary for LWLINK is called "lwlink". Note that the binary is in lower
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1920 case. lwlink takes the following command line arguments.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1921 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1922 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1923 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1924 <term><option>--decb</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1925 <term><option>-b</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1926 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1927 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1928 Selects the DECB output format target. This is equivalent to <option>--format=decb</option>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1929 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1930 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1931 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1932
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1933 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1934 <term><option>--output=FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1935 <term><option>-o FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1936 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1937 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1938 This option specifies the name of the output file. If not specified, the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1939 default is <option>a.out</option>.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1940 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1941 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1942 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1943
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1944 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1945 <term><option>--format=TYPE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1946 <term><option>-f TYPE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1947 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1948 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1949 This option specifies the output format. Valid values are <option>decb</option>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1950 and <option>raw</option>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1951 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1952 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1953 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1954
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1955 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1956 <term><option>--raw</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1957 <term><option>-r</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1958 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1959 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1960 This option specifies the raw output format.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1961 It is equivalent to <option>--format=raw</option>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1962 and <option>-f raw</option>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1963 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1964 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1965 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1966
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1967 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1968 <term><option>--script=FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1969 <term><option>-s</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1970 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1971 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1972 This option allows specifying a linking script to override the linker's
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1973 built in defaults.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1974 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1975 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1976 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1977
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1978 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1979 <term><option>--section-base=SECT=BASE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1980 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1981 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1982 Cause section SECT to load at base address BASE. This will be prepended
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1983 to the built-in link script. It is ignored if a link script is provided.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1984 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1985 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1986 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1987
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1988 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1989 <term><option>--map=FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1990 <term><option>-m FILE</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1991 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1992 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1993 This will output a description of the link result to FILE.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1994 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1995 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1996 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1997
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1998 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	1999 <term><option>--library=LIBSPEC</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2000 <term><option>-l LIBSPEC</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2001 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2002 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2003 Load a library using the library search path. LIBSPEC will have "lib" prepended
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2004 and ".a" appended.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2005 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2006 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2007 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2008
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2009 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2010 <term><option>--library-path=DIR</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2011 <term><option>-L DIR</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2012 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2013 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2014 Add DIR to the library search path.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2015 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2016 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2017 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2018
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2019 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2020 <term><option>--debug</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2021 <term><option>-d</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2022 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2023 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2024 This option increases the debugging level. It is only useful for LWTOOLS
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2025 developers.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2026 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2027 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2028 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2029
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2030 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2031 <term><option>--help</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2032 <term><option>-?</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2033 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2034 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2035 This provides a listing of command line options and a brief description
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2036 of each.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2037 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2038 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2039 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2040
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2041 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2042 <term><option>--usage</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2043 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2044 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2045 This will display a usage summary
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2046 of each command line option.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2047 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2048 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2049 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2050
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2051
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2052 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2053 <term><option>--version</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2054 <term><option>-V</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2055 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2056 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2057 This will display the version of LWLINK.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2058 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2059 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2060 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2061
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2062 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2063
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2064 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2065 <title>Linker Operation</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2066
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2067 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2068
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2069 LWLINK takes one or more files in supported input formats and links them
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2070 into a single binary. Currently supported formats are the LWTOOLS object
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2071 file format and the archive format used by LWAR. While the precise method is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2072 slightly different, linking can be conceptualized as the following steps.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2073
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2074 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2075
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2076 <orderedlist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2077 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2078 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2079 First, the linker loads a linking script. If no script is specified, it
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2080 loads a built-in default script based on the output format selected. This
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2081 script tells the linker how to lay out the various sections in the final
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2082 binary.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2083 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2084 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2085
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2086 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2087 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2088 Next, the linker reads all the input files into memory. At this time, it
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2089 flags any format errors in those files. It constructs a table of symbols
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2090 for each object at this time.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2091 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2092 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2093
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2094 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2095 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2096 The linker then proceeds with organizing the sections loaded from each file
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2097 according to the linking script. As it does so, it is able to assign addresses
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2098 to each symbol defined in each object file. At this time, the linker may
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2099 also collapse different instances of the same section name into a single
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2100 section by appending the data from each subsequent instance of the section
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2101 to the first instance of the section.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2102 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2103 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2104
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2105 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2106 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2107 Next, the linker looks through every object file for every incomplete reference.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2108 It then attempts to fully resolve that reference. If it cannot do so, it
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2109 throws an error. Once a reference is resolved, the value is placed into
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2110 the binary code at the specified section. It should be noted that an
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2111 incomplete reference can reference either a symbol internal to the object
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2112 file or an external symbol which is in the export list of another object
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2113 file.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2114 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2115 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2116
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2117 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2118 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2119 If all of the above steps are successful, the linker opens the output file
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2120 and actually constructs the binary.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2121 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2122 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2123 </orderedlist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2124
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2125 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2126
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2127 <section
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2128 <title>Linking Scripts</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2129 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2130 A linker script is used to instruct the linker about how to assemble the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2131 various sections into a completed binary. It consists of a series of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2132 directives which are considered in the order they are encountered.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2133 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2134 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2135 The sections will appear in the resulting binary in the order they are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2136 specified in the script file. If a referenced section is not found, the linker will behave as though the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2137 section did exist but had a zero size, no relocations, and no exports.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2138 A section should only be referenced once. Any subsequent references will have
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2139 an undefined effect.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2140 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2141
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2142 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2143 All numbers are in linking scripts are specified in hexadecimal. All directives
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2144 are case sensitive although the hexadecimal numbers are not.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2145 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2146
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2147 <para>A section name can be specified as a "*", then any section not
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2148 already matched by the script will be matched. The "*" can be followed
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2149 by a comma and a flag to narrow the section down slightly, also.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2150 If the flag is "!bss", then any section that is not flagged as a bss section
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2151 will be matched. If the flag is "bss", then any section that is flagged as
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2152 bss will be matched.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2153 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2154
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2155 <para>The following directives are understood in a linker script.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2156 <variablelist>
234 d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2157
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2158 <varlistentry>
236 ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2159 <term>sectopt <parameter>section</parameter> padafter <parameter>byte,...</parameter></term>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2160 <listitem>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2161
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2162 <para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2163
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2164 This will cause the linker to append the specified list of byte values
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2165 (specified in hexadecimal separated by commas) to the end of the named
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2166 section. This is done once all instances of the specified section are
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2167 collected together. This has no effect if the specified section does not
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2168 appear anywhere in any of the objects specified for linking.
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2169
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2170 </para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2171
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2172 <para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2173
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2174 If code depends on the presence of this padding somewhere, it is sufficient
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2175 to include an empty section of the specified name in the object that depends
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2176 on it.
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2177
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2178 </para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2179
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2180 </listitem>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2181
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2182 <varlistentry>
234 d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2183 <term>define basesympat <parameter>string</parameter></term>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2184 <listitem>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2185
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2186 <para>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2187
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2188 This causes the linker to define a symbol for the ultimate base address of
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2189 each section using the pattern specified by <parameter>string</parameter>.
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2190 In the string, %s can appear exactly once and will be replaced with the
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2191 section name. The base address is calculated after all instances of each
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2192 section have been collapsed together.
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2193
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2194 </para>
236 ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2195
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2196 <para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2197
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2198 It should be noted that if none of the objects to be linked contains a
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2199 particular section name, there will be no base symbol defined for it, even
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2200 if it is listed explicitly in the link script. If code depends on the
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2201 presence of these symbols, it is sufficient to include an empty section of
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2202 the specified name in the object that depends on it.
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2203
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2204 </para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2205
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2206
234 d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2207 <para> If the pattern resolves to the same string for multiple
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2208 sections, the results are undefined.
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2209
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2210 </para>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2211 </listitem>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2212
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2213 <varlistentry>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2214 <term>define lensympat <parameter>string</parameter></term>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2215 <listitem>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2216
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2217 <para>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2218
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2219 This causes the linker to define a symbol for the ultimate length of each
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2220 section using the pattern specified by <parameter>string</parameter>. In
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2221 the string, %s can appear exactly once and will be replaced with the section
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2222 name. The length is calculated after all instances of a section have been
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2223 collapsed together.
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2224
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2225 </para>
236 ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2226
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2227 <para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2228
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2229 It should be noted that if none of the objects to be linked contains a
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2230 particular section name, there will be no length symbol defined for it, even
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2231 if it is listed explicitly in the link script. If code depends on the
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2232 presence of these symbols, it is sufficient to include an empty section of
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2233 the specified name in the object that depends on it.
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2234
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2235 </para>
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2236
ce1fdc8d6568 Added ability to add padding after a section when linking. William Astle <lost@l-w.ca> parents: 234 diff changeset	2237
234 d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2238 <para>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2239 If the pattern resolves to the same string for multiple
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2240 sections, the results are undefined.
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2241
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2242 </para>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2243 </listitem>
d389adbcc4ab Added section base and length symbols to lwlink William Astle <lost@l-w.ca> parents: 232 diff changeset	2244
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2245 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2246 <term>section <parameter>name</parameter> load <parameter>addr</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2247 <listitem><para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2248
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2249 This causes the section <parameter>name</parameter> to load at
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2250 <parameter>addr</parameter>. For the raw target, only one "load at" entry is
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2251 allowed for non-bss sections and it must be the first one. For raw targets,
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2252 it affects the addresses the linker assigns to symbols but has no other
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2253 affect on the output. bss sections may all have separate load addresses but
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2254 since they will not appear in the binary anyway, this is okay.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2255 </para><para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2256 For the decb target, each "load" entry will cause a new "block" to be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2257 output to the binary which will contain the load address. It is legal for
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2258 sections to overlap in this manner - the linker assumes the loader will sort
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2259 everything out.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2260 </para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2261 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2262
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2263 <varlistentry>
316 c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2264 <term>section <parameter>name</parameter> high <parameter>addr</parameter></term>
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2265 <listitem><para>
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2266
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2267 This causes the section <parameter>name</parameter> to load with its end
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2268 address just below <parameter>addr</parameter>. Subsequent sections are
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2269 loaded at progressively lower addresses. This may lead to inefficient file
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2270 encoding for some targets. As of this writing, it will also almost
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2271 certainly do the wrong thing for a raw target.
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2272
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2273 </para><para>
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2274
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2275 This is useful for aligning a block of code with high memory. As an
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2276 example, if the total size of a section is $100 bytes and a high address of
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2277 $FE00 is specified, the section will actually load at $FD00.
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2278
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2279 </para></listitem>
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2280 </varlistentry>
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2281
c4853a54b4a1 Documented new "high" option for link scripts. William Astle <lost@l-w.ca> parents: 254 diff changeset	2282 <varlistentry>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2283 <term>section <parameter>name</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2284 <listitem><para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2285
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2286 This will cause the section <parameter>name</parameter> to load after the previously listed
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2287 section.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2288 </para></listitem></varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2289 <varlistentry>
68 99ce348b0e6b Fixed error in documentation - linkscripts use "entry" instead of "exec" lost@l-w.ca parents: 60 diff changeset	2290 <term>entry <parameter>addr or sym</parameter></term>
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2291 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2292 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2293 This will cause the execution address (entry point) to be the address
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2294 specified (in hex) or the specified symbol name. The symbol name must
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2295 match a symbol that is exported by one of the object files being linked.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2296 This has no effect for targets that do not encode the entry point into the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2297 resulting file. If not specified, the entry point is assumed to be address 0
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2298 which is probably not what you want. The default link scripts for targets
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2299 that support this directive automatically starts at the beginning of the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2300 first section (usually "init" or "code") that is emitted in the binary.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2301 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2302 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2303 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2304
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2305 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2306 <term>pad <parameter>size</parameter></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2307 <listitem><para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2308 This will cause the output file to be padded with NUL bytes to be exactly
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2309 <parameter>size</parameter> bytes in length. This only makes sense for a raw target.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2310 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2311 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2312 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2313 </variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2314
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2315
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2316
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2317 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2318
152 a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2319 <section>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2320 <title>Format Specific Linking Notes</title>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2321
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2322 <para>Some formats require special information to be able to generate actual
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2323 binaries. If the specific format you are interested in is not listed in
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2324 this section, then there is nothing special you need to know about to create
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2325 a final binary.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2326
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2327 <section>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2328 <title>OS9 Modules</title>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2329
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2330 <para>OS9 modules need to embed several items into the module header. These
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2331 items are the type of module, the langauge of the module, the module
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2332 attributes, the module revision number, the data size (bss), and the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2333 execution offset. These are all either calculated or default to reasonable
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2334 values.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2335
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2336 <para>The data size is calcuated as the sum of all sections named "bss" or
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2337 ".bss" in all object files that are linked together.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2338
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2339 <para>The execution offset is calculated from the address of the special
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2340 symbol "__start" which must be an exported (external) symbol in one of the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2341 objects to be linked.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2342
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2343 <para>The type defaults to "Prgrm" or "Program module". The language
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2344 defaults to "Objct" or "6809 object code". Attributes default to enabling
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2345 the re-entrant flag. And finally, the revision defaults to zero.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2346
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2347 <para>The embedded module name is the output filename. If the output
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2348 filename includes more than just the filename, this will probably not be
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2349 what you want.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2350
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2351 <para>The type, language, attributes, revision, and module name can all be
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2352 overridden by providing a special section in exactly one of the object files
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2353 to be linked. This section is called "__os9" (note the two underscores).
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2354 To override the type, language, attributes, or revision values, define a
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2355 non-exported symbol in this section called "type", "lang", "attr", or "rev"
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2356 respectively. Any other symbols defined are ignored. To override the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2357 module name, include as the only actual code in the section a NUL terminated
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2358 string (the FCN directive is useful for this). If there is no code in the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2359 section or it beings with a NUL, the default name will be used. Any of the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2360 preceeding that are not defined in the special section will retain their
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2361 default values.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2362
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2363 <para>The built-in link script for OS9 modules will place the following
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2364 sections, in order, in the module: "code", ".text", "data", ".data". It
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2365 will merge all sections with the name "bss" or ".bss" into the "data"
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2366 section. All other section names are ignored. What this means is that you
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2367 must define your data variables in the a section called "bss" or ".bss" even
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2368 though you will be refencing them all as offsets from U. This does have the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2369 unpleasant side effect that all BSS references will end up being 16 bit
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2370 offsets because the assembler cannot know what the offset will be once the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2371 linker is finished its work. Thus, if the tightest possible code is
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2372 required, having LWASM directly output the module is a better choice.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2373
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2374 <para>While the built-in link script is probably sufficient for most
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2375 purposes, you can provide your own script. If you provide a custom link
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2376 script, you must start your code and data sections at location 000D to
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2377 accommodate the module header. Otherwise, you will have an incorrect
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2378 location for the execution offset. You must use the ENTRY directive in the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2379 script to define the entry point for the module.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2380
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2381 <para>It should also be obvious from the above that you cannot mix the bss
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2382 (rmb) definitions with the module code when linking separately. Those
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2383 familiar with typical module creation will probably find this an unpleasant
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2384 difference but it is unavoidable.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2385
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2386 <para>It should also be noted that direct page references should also be
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2387 avoided because you cannot know ahead of time whether the linker is going to
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2388 end up putting a particular variable in the first 256 bytes of the module's
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2389 data space. If, however, you know for certain you will have less than 256
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2390 bytes of defined data space across all of the object files that will be
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2391 linked, you can instead use forced DP addressing for your data addresses
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2392 instead of the ,u notation. When linking with 3rd party libraries, this
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2393 practice should be avoided. Also, when creating libraries, always use the
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2394 offset from U technique.</para>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2395
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2396 </section>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2397
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2398 </section>
a26b045c4e18 Added documentation about OS9 module support in lwlink lost@l-w.ca parents: 143 diff changeset	2399
0 2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2400 </chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2401
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2402 <chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2403 <title>Libraries and LWAR</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2404
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2405 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2406 LWTOOLS also includes a tool for managing libraries. These are analogous to
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2407 the static libraries created with the "ar" tool on POSIX systems. Each library
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2408 file contains one or more object files. The linker will treat the object
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2409 files within a library as though they had been specified individually on
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2410 the command line except when resolving external references. External references
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2411 are looked up first within the object files within the library and then, if
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2412 not found, the usual lookup based on the order the files are specified on
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2413 the command line occurs.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2414 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2415
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2416 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2417 The tool for creating these libary files is called LWAR.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2418 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2419
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2420 <section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2421 <title>Command Line Options</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2422 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2423 The binary for LWAR is called "lwar". Note that the binary is in lower
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2424 case. The options lwar understands are listed below. For archive manipulation
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2425 options, the first non-option argument is the name of the archive. All other
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2426 non-option arguments are the names of files to operate on.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2427 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2428
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2429 <variablelist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2430 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2431 <term><option>--add</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2432 <term><option>-a</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2433 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2434 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2435 This option specifies that an archive is going to have files added to it.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2436 If the archive does not already exist, it is created. New files are added
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2437 to the end of the archive.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2438 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2439 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2440 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2441
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2442 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2443 <term><option>--create</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2444 <term><option>-c</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2445 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2446 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2447 This option specifies that an archive is going to be created and have files
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2448 added to it. If the archive already exists, it is truncated.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2449 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2450 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2451 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2452
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2453 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2454 <term><option>--merge</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2455 <term><option>-m</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2456 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2457 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2458 If specified, any files specified to be added to an archive will be checked
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2459 to see if they are archives themselves. If so, their constituent members are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2460 added to the archive. This is useful for avoiding archives containing archives.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2461 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2462 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2463 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2464
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2465 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2466 <term><option>--list</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2467 <term><option>-l</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2468 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2469 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2470 This will display a list of the files contained in the archive.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2471 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2472 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2473 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2474
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2475 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2476 <term><option>--debug</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2477 <term><option>-d</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2478 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2479 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2480 This option increases the debugging level. It is only useful for LWTOOLS
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2481 developers.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2482 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2483 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2484 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2485
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2486 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2487 <term><option>--help</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2488 <term><option>-?</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2489 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2490 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2491 This provides a listing of command line options and a brief description
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2492 of each.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2493 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2494 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2495 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2496
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2497 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2498 <term><option>--usage</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2499 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2500 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2501 This will display a usage summary
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2502 of each command line option.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2503 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2504 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2505 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2506
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2507
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2508 <varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2509 <term><option>--version</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2510 <term><option>-V</option></term>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2511 <listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2512 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2513 This will display the version of LWLINK.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2514 of each.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2515 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2516 </listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2517 </varlistentry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2518
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2519 </section>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2520
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2521 </chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2522
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2523 <chapter id="objchap">
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2524 <title>Object Files</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2525 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2526 LWTOOLS uses a proprietary object file format. It is proprietary in the sense
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2527 that it is specific to LWTOOLS, not that it is a hidden format. It would be
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2528 hard to keep it hidden in an open source tool chain anyway. This chapter
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2529 documents the object file format.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2530 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2531
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2532 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2533 An object file consists of a series of sections each of which contains a
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2534 list of exported symbols, a list of incomplete references, and a list of
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2535 "local" symbols which may be used in calculating incomplete references. Each
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2536 section will obviously also contain the object code.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2537 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2538
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2539 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2540 Exported symbols must be completely resolved to an address within the
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2541 section it is exported from. That is, an exported symbol must be a constant
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2542 rather than defined in terms of other symbols.</para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2543
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2544 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2545 Each object file starts with a magic number and version number. The magic
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2546 number is the string "LWOBJ16" for this 16 bit object file format. The only
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2547 defined version number is currently 0. Thus, the first 8 bytes of the object
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2548 file are <code>4C574F424A313600</code>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2549 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2550
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2551 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2552 Each section has the following items in order:
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2553 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2554
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2555 <itemizedlist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2556 <listitem><para>section name</para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2557 <listitem><para>flags</para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2558 <listitem><para>list of local symbols (and addresses within the section)</para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2559 <listitem><para>list of exported symbols (and addresses within the section)</para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2560 <listitem><para>list of incomplete references along with the expressions to calculate them</para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2561 <listitem><para>the actual object code (for non-BSS sections)</para></listitem>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2562 </itemizedlist>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2563
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2564 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2565 The section starts with the name of the section with a NUL termination
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2566 followed by a series of flag bytes terminated by NUL. There are only two
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2567 flag bytes defined. A NUL (0) indicates no more flags and a value of 1
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2568 indicates the section is a BSS section. For a BSS section, no actual
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2569 code is included in the object file.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2570 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2571
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2572 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2573 Either a NULL section name or end of file indicate the presence of no more
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2574 sections.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2575 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2576
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2577 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2578 Each entry in the exported and local symbols table consists of the symbol
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2579 (NUL terminated) followed by two bytes which contain the value in big endian
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2580 order. The end of a symbol table is indicated by a NULL symbol name.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2581 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2582
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2583 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2584 Each entry in the incomplete references table consists of an expression
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2585 followed by a 16 bit offset where the reference goes. Expressions are
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2586 defined as a series of terms up to an "end of expression" term. Each term
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2587 consists of a single byte which identifies the type of term (see below)
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2588 followed by any data required by the term. Then end of the list is flagged
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2589 by a NULL expression (only an end of expression term).
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2590 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2591
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2592 <table frame="all"><title>Object File Term Types</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2593 <tgroup cols="2">
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2594 <thead>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2595 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2596 <entry>TERMTYPE</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2597 <entry>Meaning</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2598 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2599 </thead>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2600 <tbody>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2601 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2602 <entry>00</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2603 <entry>end of expression</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2604 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2605
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2606 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2607 <entry>01</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2608 <entry>integer (16 bit in big endian order follows)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2609 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2610 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2611 <entry>02</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2612 <entry> external symbol reference (NUL terminated symbol name follows)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2613 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2614
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2615 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2616 <entry>03</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2617 <entry>local symbol reference (NUL terminated symbol name follows)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2618 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2619
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2620 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2621 <entry>04</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2622 <entry>operator (1 byte operator number)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2623 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2624 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2625 <entry>05</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2626 <entry>section base address reference</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2627 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2628
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2629 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2630 <entry>FF</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2631 <entry>This term will set flags for the expression. Each one of these terms will set a single flag. All of them should be specified first in an expression. If they are not, the behaviour is undefined. The byte following is the flag. Flag 01 indicates an 8 bit relocation. Flag 02 indicates a zero-width relocation (see the EXTDEP pseudo op in LWASM).</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2632 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2633 </tbody>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2634 </tgroup>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2635 </table>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2636
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2637
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2638 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2639 External references are resolved using other object files while local
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2640 references are resolved using the local symbol table(s) from this file. This
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2641 allows local symbols that are not exported to have the same names as
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2642 exported symbols or external references.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2643 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2644
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2645 <table frame="all"><title>Object File Operator Numbers</title>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2646 <tgroup cols="2">
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2647 <thead>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2648 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2649 <entry>Number</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2650 <entry>Operator</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2651 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2652 </thead>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2653 <tbody>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2654 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2655 <entry>01</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2656 <entry>addition (+)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2657 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2658 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2659 <entry>02</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2660 <entry>subtraction (-)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2661 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2662 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2663 <entry>03</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2664 <entry>multiplication (*)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2665 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2666 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2667 <entry>04</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2668 <entry>division (/)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2669 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2670 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2671 <entry>05</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2672 <entry>modulus (%)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2673 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2674 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2675 <entry>06</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2676 <entry>integer division (\) (same as division)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2677 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2678
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2679 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2680 <entry>07</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2681 <entry>bitwise and</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2682 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2683
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2684 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2685 <entry>08</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2686 <entry>bitwise or</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2687 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2688
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2689 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2690 <entry>09</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2691 <entry>bitwise xor</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2692 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2693
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2694 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2695 <entry>0A</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2696 <entry>boolean and</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2697 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2698
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2699 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2700 <entry>0B</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2701 <entry>boolean or</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2702 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2703
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2704 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2705 <entry>0C</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2706 <entry>unary negation, 2's complement (-)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2707 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2708
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2709 <row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2710 <entry>0D</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2711 <entry>unary 1's complement (^)</entry>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2712 </row>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2713 </tbody>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2714 </tgroup>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2715 </table>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2716
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2717 <para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2718 An expression is represented in a postfix manner with both operands for
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2719 binary operators preceding the operator and the single operand for unary
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2720 operators preceding the operator.
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2721 </para>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2722
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2723 </chapter>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2724 </book>
2c24602be78f Initial import from lwtools 3.0.1 version, with new hand built build system and file reorganization lost@l-w.ca parents: diff changeset	2725

Mercurial > hg > index.cgi

annotate docs/manual.docbook.sgml @ 364:44270b66df3c