git.sur5r.net Git - cc65/blob - doc/sim65.sgml

   1 <!doctype linuxdoc system>      <!-- -*- text-mode -*- -->
   2
   3 <article>
   4
   5 <title>sim65 Users Guide
   6 <author><url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">
   7 <date>2016-01-05
   8
   9 <abstract>
  10 sim65 is a simulator for 6502 and 65C02 CPUs. It allows to test target
  11 independed code.
  12 </abstract>
  13
  14 <!-- Table of contents -->
  15 <toc>
  16
  17 <!-- Begin the document -->
  18
  19 <sect>Overview<p>
  20
  21
  22 sim65 is the only solution as part of the toolchain to execute code. The
  23 binary needs to be compiled with <tt/--target sim6502/ or <tt/--target sim65c02/.
  24
  25
  26 <sect>Usage<p>
  27
  28 The simulator is called as follows:
  29
  30 <tscreen><verb>
  31         Usage: sim65 [options] file [arguments]
  32         Short options:
  33           -h                    Help (this text)
  34           -v                    Increase verbosity
  35           -V                    Print the simulator version number
  36           -x <num>              Exit simulator after <num> cycles
  37
  38         Long options:
  39           --help                Help (this text)
  40           --verbose             Increase verbosity
  41           --version             Print the simulator version number
  42 </verb></tscreen>
  43
  44
  45 <sect1>Command line options in detail<p>
  46
  47 Here is a description of all the command line options:
  48
  49 <descrip>
  50
  51   <tag><tt>-h, --help</tt></tag>
  52
  53   Print the short option summary shown above.
  54
  55
  56   <tag><tt>-v, --verbose</tt></tag>
  57
  58   Increase the simulator verbosity.
  59
  60
  61   <tag><tt>-V, --version</tt></tag>
  62
  63   Print the version number of the utility. When submitting a bug report,
  64   please include the operating system you're using, and the compiler
  65   version.
  66
  67
  68   <tag><tt>-x num</tt></tag>
  69
  70   Exit simulator after num cycles.
  71 </descrip>
  72
  73
  74 <sect>Input and output<p>
  75
  76 The simulator will read one binary file per invocation and can log the
  77 program loading and paravirtualization calls to stderr.
  78
  79 Example output for the command
  80 <tscreen><verb>
  81 sim65 --verbose --verbose samples/gunzip65
  82 </verb></tscreen>
  83 <tscreen><verb>
  84 Loaded `samples/gunzip65' at $0200-$151F
  85 PVWrite ($0001, $13C9, $000F)
  86 GZIP file name:PVWrite ($0001, $151F, $0001)
  87
  88 PVRead ($0000, $FFD7, $0001)
  89 PVOpen ("", $0001)
  90 PVRead ($0003, $1520, $6590)
  91 PVClose ($0003)
  92 PVWrite ($0001, $13D9, $000F)
  93 Not GZIP formatPVWrite ($0001, $151F, $0001)
  94
  95 PVExit ($01)
  96 </verb></tscreen>
  97
  98
  99
 100 <sect>Copyright<p>
 101
 102 sim65 (and all cc65 binutils) are (C) Copyright 1998-2000 Ullrich von
 103 Bassewitz. For usage of the binaries and/or sources the following conditions
 104 do apply:
 105
 106 This software is provided 'as-is', without any expressed or implied
 107 warranty.  In no event will the authors be held liable for any damages
 108 arising from the use of this software.
 109
 110 Permission is granted to anyone to use this software for any purpose,
 111 including commercial applications, and to alter it and redistribute it
 112 freely, subject to the following restrictions:
 113
 114 <enum>
 115 <item>  The origin of this software must not be misrepresented; you must not
 116         claim that you wrote the original software. If you use this software
 117         in a product, an acknowledgment in the product documentation would be
 118         appreciated but is not required.
 119 <item>  Altered source versions must be plainly marked as such, and must not
 120         be misrepresented as being the original software.
 121 <item>  This notice may not be removed or altered from any source
 122         distribution.
 123 </enum>
 124
 125 </article>