.. rrhelp.txt

File last touched at: 31.08.2002

 
--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------
               *   * **** Retargetable Replay v0.5 **** *   *
--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------

contents:

    * todo/history

    * known bugs

    * user manual
        - configuration
        - command line options
        - Debugger
        - Monitor
        - Console/Fileserver
        - Terminal

        - additional tools
          - rrdis
          - rrasm
          - rred

    * target information
        - c64

    * additional info

    * terms of use and distribution

    * credits

--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------

history and to-do list was moved to seperate files, please have a look at
rrhistory.txt and rrtodo.txt.

--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------
                      -=- known issues and problems -=-
--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------

- on win32 there was a flaw in the keyboard handling, sometimes required to
  abort the program by pressing ctrl+c. This should be fixed now, if the key-
  board still appears to lock up for you, please let me know.

- debugger windows always operate in "auto-update" for now, thus also keys for
  "toggle update" and "reread current" have no effect. this is NOT a bug.

- switching target-memory banks is not handled for now, this needs further
  development - possibly will take some time.

- serial-port handling is currently broken in cygwin compiled version

           for bug-reporting and suggestions email groepaz@gmx.net

--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------
                             -=- User Manual -=-
--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
configuration
--------------------------------------------------------------------------------

you might want to add the directory where you installed rr.exe to your search-
path so you can run the rr-program from any directory.

please look at the supplied .ini files for some comments about configuring the
rr-program.... atleast, enter the correct name and adress for your serial port
device in rr.ini.

--------------------------------------------------------------------------------
command-line options:
--------------------------------------------------------------------------------

usage: rr [command] [args] [extra switches]

load     [filename] [start] [end] [offset]  load prg-file to target memory
loadbin  [filename] [start] [end] [offset]  load bin-file to target memory
loadsid  [filename]                         load sid-file to target memory
save     [filename] [start] [end]           save prg-file from target memory
run      [filename] [start]                 load prg-file and run
flash    [filename]                         flash target debug rom
jump     [address]                          jump to address
poke     [address] [byte]                   write byte to target memory
fill     [start] [end] [byte]               fill target memory memory with byte
mon                                         enter monitor
con                                         console/fileserver mode
term                                        simple terminal mode
dump                                        terminal dump/test mode
sim                                         start debugger in simulator mode
ice                                         start debugger in ice-breaker mode

running rr.exe without any arguments starts debugger.

extra switches:

-h -?                                       get this help
-c                                          enter console mode after run
-s                                          silent mode (for batchfiles)

all numeric values can be either decimal (1234) or hex (0x1234)

--------------------------------------------------------------------------------
The Debugger
--------------------------------------------------------------------------------

to enter the debugger, run rr.exe without arguments.

keyboard-layout:

F1     show Help
F5     ReRead Data in current window (if auto update off)
F6/F7  toggle Auto Update
F8     Freeze/Unfreeze Target

F9     Load/Run
F10    enter Monitor
F11    enter Console
F12    enter Terminal
ESC    Quit

Cursor-Keys + Page Up/Down     Scroll in Windows

Tab    Toggle active Window (Top/Bottom)
1...0  select slot

m      enter adress + switch to data mode
i/j    enter adress + switch to screencode/text mode
d      enter adress + switch to disassembly mode
g      enter adress, set pc to adress and run target
l      <filename> <startaddr>       load file
s      <filename> <start> <end>     save file

Enter   edit active Window

???    link windows
???    toggle current window full/half size

--------------------------------------------------------------------------------
The Monitor
--------------------------------------------------------------------------------

available commands:

?                              prints help text

c                              enter console mode
d <startaddr> <endaddr>        disassemble
f <startaddr> <endaddr> <byte> fill memory
g <address>                    jump to address
i <startaddr> <endaddr>        dump memory as screencode
j <startaddr> <endaddr>        dump memory as text
l <filename> <startaddr>       load file
m <startaddr> <endaddr>        dump memory as hexcode
s <filename> <start> <end>     save file
x                              exit
. <address> <byte>...<byte>    write memory
# <char> <byte>...<byte>       send raw Target-Stub command
' <byte>...<byte>              send raw Target-Stub command

available hotkeys:

F1/F2                          Freeze/Unfreeze Target

all numeric values can be either decimal (1234) or hex (0x1234)

--------------------------------------------------------------------------------
The Console
--------------------------------------------------------------------------------

accepts debug-printing from the Target and features a fileserver.

to enter console/fileserver mode, enter "rr con" on the commandline, or press
F11 in the debugger main screen.

available Hotkeys:

F1-Help
F11-Toggle Fileserver messages
F12-Toggle Fileserver/Console emulation mode
ESC-Exit console

currently supported fileserver emulations are:

- generic/rr
- serial slave
- cbm/retroreplay

--------------------------------------------------------------------------------
The Terminal
--------------------------------------------------------------------------------

just a dumb Ascii Terminal, mostly useful for testing-purposes.

to enter terminal mode, press F12 in the debugger main window or enter "rr term"
(or "rr dump" for even more verbose testing) on the commandline.

available Hotkeys:

ESC-Exit Terminal

--------------------------------------------------------------------------------
additional tools
--------------------------------------------------------------------------------

rrdis:
  half-automatic disassembler.

usage: rrdis [options] filename
Options:
  -b<address>   base address
  -e<address>   entry point
  -o<filename>  file to write output to (default: stdout)
  filename      file to disassemble

rrasm:
  simple tasm-style line-assembler
  not functional for 6510 yet.

usage: rrasm [options] filename

rred:
tasm-style assembler-source editor
not functional for 6510 yet.

usage: rred [filename]

--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------
        -=- additional documentation (files available in /docs) -=-
--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------

C64 Retro-Replay / Silversurfer:

    inside_retrosurfer.txt  Silversurfer programming
    inside_surfer.txt       original Silversurfer-docs
    inside_replay.txt       Retro-Replay programming

Misc:

    RS232_Cable.txt         cable info/pinout

--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------
                                -=- Credits -=-
--------------------------------------------------------------------------------
================================================================================
--------------------------------------------------------------------------------

Main Program:
                Groepaz/Hitmen

Debug Console:
                Skywalker/Hitmen, Groepaz/Hitmen

Fileserver:
                ISO level                           Groepaz/Hitmen
                CBM level                           Groepaz/Hitmen
                Serial Slave                        Groepaz/Hitmen,
                                                    original SerSlave-
                                                      tool by Magervalp.

Target-Stubs:
                Commodore C64                       Groepaz/Hitmen
                - Retro Replay integration          CountZero/Cyberpunx
                Gameboy Advanced                    Jihad/Hitmen
                Sega Dreamcast (DDH)                Skywalker/Hitmen

Disassemblers:
                6510                                Groepaz/Hitmen
                ARM7                                Groepaz/Hitmen
                SH4                                 Maiwe,Groepaz/Hitmen

supported Hardware:
                c64/Retroreplay                     Jens Schoenfeld
                dreamcast/ddh                       Skywalker/Hitmen
                gba                                 Jihad/Hitmen

moreover some shoutouts to:

        Ray/Unreal      -   for answering some dumb win32 related questions
        Benson/TRSI     -   for revealing serial-port handling in win32

--------------------------------------------------------------------------------
           for bug-reporting and suggestions email groepaz@gmx.net
--------------------------------------------------------------------------------

 

generated by txt2htm v0.1a (w)2001 Groepaz/Hitmen