doc/index.html

   1 <html lang="en">
   2 <head>
   3 <title>The XORcyst Manual</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="The XORcyst Manual">
   6 <meta name="generator" content="makeinfo 4.7">
   7 <link title="Top" rel="start" href="#Top">
   8 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
   9 <!--
  10 This is the manual for The XORcyst version 1.5.2.
  11
  12 Copyright (C) 2004, 2005, 2007, 2008, 2009 Kent Hansen.-->
  13 <meta http-equiv="Content-Style-Type" content="text/css">
  14 <style type="text/css"><!--
  15   pre.display { font-family:inherit }
  16   pre.format  { font-family:inherit }
  17   pre.smalldisplay { font-family:inherit; font-size:smaller }
  18   pre.smallformat  { font-family:inherit; font-size:smaller }
  19   pre.smallexample { font-size:smaller }
  20   pre.smalllisp    { font-size:smaller }
  21   span.sc { font-variant:small-caps }
  22   span.roman { font-family: serif; font-weight: normal; }
  23 --></style>
  24 </head>
  25 <body>
  26 <h1 class="settitle">The XORcyst Manual</h1>
  27    <div class="contents">
  28 <h2>Table of Contents</h2>
  29 <ul>
  30 <li><a name="toc_Top" href="index.html#Top">The XORcyst Manual</a>
  31 <li><a name="toc_What_0027s-New" href="What_0027s-New.html#What_0027s-New">1 What's New</a>
  32 <li><a name="toc_Overview" href="Overview.html#Overview">2 Overview</a>
  33 <li><a name="toc_The-Assembler" href="The-Assembler.html#The-Assembler">3 The Assembler</a>
  34 <ul>
  35 <li><a href="The-Assembler.html#The-Assembler">3.1 Invoking the assembler (<span class="command">xasm</span>)</a>
  36 <ul>
  37 <li><a href="The-Assembler.html#The-Assembler">3.1.1 Switches</a>
  38 </li></ul>
  39 <li><a href="The-Assembler.html#The-Assembler">3.2 Assembler statements</a>
  40 <ul>
  41 <li><a href="The-Assembler.html#The-Assembler">3.2.1 A simple assembler example</a>
  42 <li><a href="The-Assembler.html#The-Assembler">3.2.2 Literals</a>
  43 <li><a href="The-Assembler.html#The-Assembler">3.2.3 Identifiers</a>
  44 <li><a href="The-Assembler.html#The-Assembler">3.2.4 Expressions</a>
  45 <li><a href="The-Assembler.html#The-Assembler">3.2.5 Global labels</a>
  46 <li><a href="The-Assembler.html#The-Assembler">3.2.6 Local labels</a>
  47 <li><a href="The-Assembler.html#The-Assembler">3.2.7 Forward/backward branches</a>
  48 <li><a href="The-Assembler.html#The-Assembler">3.2.8 Equates</a>
  49 <li><a href="The-Assembler.html#The-Assembler">3.2.9 Conditional assembly</a>
  50 <li><a href="The-Assembler.html#The-Assembler">3.2.10 Macros</a>
  51 <li><a href="The-Assembler.html#The-Assembler">3.2.11 Anonymous macros</a>
  52 <li><a href="The-Assembler.html#The-Assembler">3.2.12 Including files</a>
  53 <li><a href="The-Assembler.html#The-Assembler">3.2.13 Defining native data</a>
  54 <li><a href="The-Assembler.html#The-Assembler">3.2.14 User-defined types</a>
  55 <li><a href="The-Assembler.html#The-Assembler">3.2.15 Defining data of user-defined types</a>
  56 <li><a href="The-Assembler.html#The-Assembler">3.2.16 Indexing symbols statically</a>
  57 <li><a href="The-Assembler.html#The-Assembler">3.2.17 Procedures</a>
  58 <li><a href="The-Assembler.html#The-Assembler">3.2.18 Importing and exporting symbols</a>
  59 <li><a href="The-Assembler.html#The-Assembler">3.2.19 Controlling data mapping</a>
  60 <li><a href="The-Assembler.html#The-Assembler">3.2.20 An important note on indirect addressing</a>
  61 </li></ul>
  62 </li></ul>
  63 <li><a name="toc_The-Linker" href="The-Linker.html#The-Linker">4 The Linker</a>
  64 <ul>
  65 <li><a href="The-Linker.html#The-Linker">4.1 Invoking the linker (<span class="command">xlnk</span>)</a>
  66 <li><a href="The-Linker.html#The-Linker">4.2 A simple linker script example</a>
  67 <li><a href="The-Linker.html#The-Linker">4.3 Linking multiple units</a>
  68 <li><a href="The-Linker.html#The-Linker">4.4 Separating units into banks</a>
  69 <li><a href="The-Linker.html#The-Linker">4.5 Partitioning 6502 RAM</a>
  70 <li><a href="The-Linker.html#The-Linker">4.6 Copying files to linker output</a>
  71 <li><a href="The-Linker.html#The-Linker">4.7 Padding the output</a>
  72 </li></ul>
  73 <li><a name="toc_Known-Bugs-and-Limitations" href="Known-Bugs-and-Limitations.html#Known-Bugs-and-Limitations">5 Known Bugs and Limitations</a>
  74 <li><a name="toc_Implementation-Details" href="Implementation-Details.html#Implementation-Details">Appendix A Implementation Details</a>
  75 <li><a name="toc_Assembler-Directives" href="Assembler-Directives.html#Assembler-Directives">Appendix B Assembler Directives</a>
  76 <li><a name="toc_Linker-Script-Commands" href="Linker-Script-Commands.html#Linker-Script-Commands">Appendix C Linker Script Commands</a>
  77 <li><a name="toc_Object-Code-Format" href="Object-Code-Format.html#Object-Code-Format">Appendix D Object Code Format</a>
  78 <ul>
  79 <li><a href="Object-Code-Format.html#Object-Code-Format">D.1 Magic number and assembler version</a>
  80 <li><a href="Object-Code-Format.html#Object-Code-Format">D.2 Definitions of exported constants</a>
  81 <li><a href="Object-Code-Format.html#Object-Code-Format">D.3 Descriptors for imported symbols</a>
  82 <li><a href="Object-Code-Format.html#Object-Code-Format">D.4 Data segment bytecodes</a>
  83 <li><a href="Object-Code-Format.html#Object-Code-Format">D.5 Code segment bytecodes</a>
  84 <li><a href="Object-Code-Format.html#Object-Code-Format">D.6 Expressions</a>
  85 </li></ul>
  86 <li><a name="toc_Custom-Character-Maps" href="Custom-Character-Maps.html#Custom-Character-Maps">Appendix E Custom Character Maps</a>
  87 <li><a name="toc_Error-and-Warning-Messages" href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">Appendix F Error and Warning Messages</a>
  88 <ul>
  89 <li><a href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">F.1 Assembler Error Messages</a>
  90 <li><a href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">F.2 Assembler Warning Messages</a>
  91 <li><a href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">F.3 Linker Error Messages</a>
  92 <ul>
  93 <li><a href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">F.3.1 Linker Script Error Messages</a>
  94 </li></ul>
  95 <li><a href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">F.4 Linker Warning Messages</a>
  96 </li></ul>
  97 </li></ul>
  98 </div>
  99
 100
 101
 102 <div class="node">
 103 <p>
 104 <a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="What_0027s-New.html#What_0027s-New">What's New</a>,
 105 Up:&nbsp;<a rel="up" accesskey="u" href="../index.html#dir">(dir)</a>
 106 <hr><br>
 107 </div>
 108
 109 <h2 class="unnumbered">The XORcyst Manual</h2>
 110
 111 <p>This is the manual for The XORcyst version 1.5.2.
 112
 113    <p>Copyright &copy; 2004, 2005, 2007, 2008, 2009 Kent Hansen.
 114
 115 <ul class="menu">
 116 <li><a accesskey="1" href="What_0027s-New.html#What_0027s-New">What's New</a>:        An overview of the latest improvements.
 117 <li><a accesskey="2" href="Overview.html#Overview">Overview</a>:          What is this thing?
 118 <li><a accesskey="3" href="The-Assembler.html#The-Assembler">The Assembler</a>:     Describes the use and operation of the XORcyst assembler.
 119 <li><a accesskey="4" href="The-Linker.html#The-Linker">The Linker</a>:        Describes the use and operation of the XORcyst linker.
 120 <li><a accesskey="5" href="Implementation-Details.html#Implementation-Details">Implementation Details</a>:  Nice-to-know technical details concerning The XORcyst's implementation.
 121 <li><a accesskey="6" href="Known-Bugs-and-Limitations.html#Known-Bugs-and-Limitations">Known Bugs and Limitations</a>:  Known bugs and limitations.
 122 <li><a accesskey="7" href="Assembler-Directives.html#Assembler-Directives">Assembler Directives</a>:  Assembler directives.
 123 <li><a accesskey="8" href="Linker-Script-Commands.html#Linker-Script-Commands">Linker Script Commands</a>:  Linker script commands.
 124 <li><a accesskey="9" href="Object-Code-Format.html#Object-Code-Format">Object Code Format</a>:  Describes the format of the assembler's output.
 125 <li><a href="Custom-Character-Maps.html#Custom-Character-Maps">Custom Character Maps </a>:  Describes the valid contents of custom character maps.
 126 <li><a href="Error-and-Warning-Messages.html#Error-and-Warning-Messages">Error and Warning Messages </a>:  Alphabetical listing.
 127 </ul>
 128
 129    </body></html>
 130