Sponsor:

Your company here — click to reach over 10,000 unique daily visitors

xroar - Man Page

Dragon and Tandy 8-bit computer emulator

Synopsis

xroar [-c conffile] [OPTION]... [FILENAME]...

Description

XRoar emulates the Dragon 32/64; Tandy Colour Computers 1, 2 and 3; the Tandy MC-10; and some other similar machines or clones. It runs on a wide variety of platforms.

Options

Options are first read from a configuration file (by default, $HOME/.xroar/xroar.conf).  Options on the command line override any found in the configuration file.

-C

Allocate a console window (Windows only)

-c conffile

Specify a configuration file.

Machines

-m name, -default-machine name

Default machine profile to select on startup.

-machine name

Create or modify named machine profile.  -machine help lists currently defined profiles.

The remaining options configure the currently selected machine:

-machine-desc text

Machine description shown in -machine help and menu options.

-machine-arch arch

Machine architecture (dragon64, dragon32, coco, coco3 or mc10)

-machine-keyboard layout

Keyboard layout (dragon, dragon200e, coco or coco3)

-machine-cpu cpu

Machine CPU (6809 or 6309).  Not applicable to the MC-10.

-bas rom

ROM image for Colour BASIC (CoCo) or Microcolour BASIC (MC-10).

-extbas rom

ROM image for Extended BASIC (Super Extended BASIC on the CoCo 3).

-altbas rom

ROM image for 64K-mode Extended BASIC (Dragon 64, Dragon 200-E).

-nobas,  -noextbas,  -noaltbas

Indicate the corresponding ROM is not fitted in this machine.

-ext-charset rom

External character generator ROM to use.

-tv-type type

TV type (pal, ntsc or pal-m).

-tv-input input

One of ‘cmp’ (composite video, no cross-colour), ‘cmp-br’ (composite video, blue-red cross-colour), ‘cmp-rb’ (composite video, red-blue cross-colour) or ‘rgb’ (RGB video, CoCo 3 only).

-vdg-type type

Indicate the VDG variant fitted. One of 6847 or 6847t1.

-ram kbytes

Amount of RAM fitted in kilobytes. Valid sizes are 4-64K for Dragon and Tandy CoCo 1/2; 128K or 512K for the Tandy CoCo 3; 2K, 4K or 20K for the Tandy MC-10.

-machine-cart name

Default cartridge to attach.

-nodos

Indicate that XRoar is not to automatically attempt to attach a DOS cartridge to this machine (the default is to try).

Cartridges

-cart name

Create or modify named cartridge profile.  -cart help lists currently defined profiles.

The remaining options configure the currently selected cartridge:

-cart-desc text

Cartridge description shown in -cart help and menu options.

-cart-type type

Cartridge base type (-cart-type help for list).

-cart-rom rom

ROM image to load ($C000-).

-cart-rom2 rom

Second ROM image to load ($E000-).

-cart-autorun

Autorun cartridge.

-cart-becker

Enable becker port where supported.

-mpi-slot slot

(MPI) initially select slot (0-3).

-mpi-load-cart [slot=]name

(MPI) insert cartridge into next or numbered slot.

These options also apply to the similar RACE Computer Expansion Cage.

Becker port

-becker

Prefer becker-enabled DOS cartridge when picked automatically.

-becker-ip address

Address or hostname of DriveWire server [127.0.0.1]

-becker-port port

Port of DriveWire server [65504]

Cassettes

-load-tape file

Attach file as tape image for reading.

-tape-write file

Open file for tape writing.

-tape-pan panning

Pan stereo input (0.0 = full left, 1.0 = full right) [0.5]

-tape-hysteresis percent

Read hysteresis as percentage of full scale [1]

-no-tape-fast

Disable fast tape loading.

-no-tape-pad-auto

Disable automatic leader padding.

-tape-ao-rate hz

Set tape writing frame rate [9600]

-tape-rewrite

Enable tape rewriting.

-tape-rewrite-gap-ms ms

Gap length in milliseconds to write in rewrite mode (1-5000ms, default 500ms).

-tape-rewrite-leader bytes

Length of leaders in bytes to write in rewrite mode (1-2048 bytes, default 256).

Floppy disks

-load-fdX file

Insert disk image file into floppy drive X (0-3).

-no-disk-write-back

Don't default to enabling write-back for disk images.

-no-disk-auto-os9

Don't try to detect headerless OS-9 JVC disk images.

-no-disk-auto-sd

Don't assume single density for 10 sec/track disks.

Hard disks

-load-hdX file

Use file as the hard disk image for drive X (0-1).

-load-sd file

Use file as the SD card image.

Keyboard

-keymap code

Host keyboard type (-keymap help for list).

-kbd-bind hostkey=[pre:]emukey

Map host key to emulated key (pre = no translate).

-kbd-translate

Enable keyboard translation.

-type string

Intercept ROM calls to type string into BASIC.

Joysticks

-joy-right name

Map right joystick.

-joy-left name

Map left joystick.

-joy-virtual name

Specify the 'virtual' joystick to cycle [kjoy0]

-joy name

Configure named joystick (-joy help for list).

The remaining options configure the currently selected joystick:

-joy-desc text

Joystick description.

-joy-axis axis=spec

Configure joystick axis.

-joy-button btn=spec

Configure joystick button.

Printers

-lp-file file

Append printer output to file.

-lp-pipe command

Pipe printer output to command.

Files

-load file

Load or attach file

-run file

Load or attach file and attempt autorun

-load-fdX file

Insert disk image file into floppy drive X (0-3).

-load-hdX file

Use file as the hard disk image for drive X (0-1).

-load-sd file

Use file as the SD card image.

-load-tape file

Attach file as tape image for reading.

-tape-write file

Open file for tape writing.

Firmware ROM images

-rompath path

ROM search path (colon-separated list)

-romlist name=list

define a ROM list

-romlist-print

print defined ROM lists

-crclist name=list

define a ROM CRC list

-crclist-print

print defined ROM CRC lists

-force-crc-match

force per-architecture CRC matches

User interface

-ui module

user-interface module (-ui help for list)

Video

-vo module

video module (-vo help for list)

-fs

start emulator full-screen if possible

-fskip frames

frameskip (default: 0)

-ccr renderer

cross-colour renderer (simple, 5bit, partial or simulated)

-gl-filter filter

OpenGL texture filter (auto, nearest or linear)

-geometry wxh+x+y

initial emulator geometry

-vo-picture p

initial picture area (-vo-picture help for list)

-no-vo-scale-60hz

disable vertical scaling for 60Hz video

-invert-text

start with text mode inverted

-vo-brightness n

set TV brightness (0-100) [50]

-vo-contrast n

set TV contrast (0-100) [50]

-vo-colour n

set TV colour saturation (0-100) [50]

-vo-hue n

set TV hue control (-179 to +180) [0]

-no-vo-colour-killer

disable colour killer (enabled by default)

Audio

-ao module

audio module (-ao help for list)

-ao-device string

device to use for audio module

-ao-format fmt

set audio sample format (-ao-format help for list)

-ao-rate hz

set audio frame rate (if supported by module)

-ao-channels n

set number of audio channels, 1 or 2

-ao-fragments n

set number of audio fragments

-ao-fragment-ms ms

set audio fragment size in ms (if supported)

-ao-fragment-frames n

set audio fragment size in samples (if supported)

-ao-buffer-ms ms

set total audio buffer size in ms (if supported)

-ao-buffer-frames n

set total audio buffer size in samples (if supported)

-ao-gain db

audio gain in dB relative to 0 dBFS [-3.0]

-volume volume

older way to specify audio volume, linear (0-100)

Debugging

-gdb

enable GDB target

-gdb-ip address

address of interface for GDB target [127.0.0.1]

-gdb-port port

port for GDB target to listen on [65520]

-trace

start with trace mode on

-debug-fdc flags

FDC debugging (see manual, or -1 for all)

-debug-file flags

file debugging (see manual, or -1 for all)

-debug-gdb flags

GDB target debugging (see manual, or -1 for all)

-debug-ui flags

UI debugging (see manual, or -1 for all)

-v,  --verbose level

general debug verbosity (0 to 3) [1]

-q,  --quiet

equivalent to --verbose 0

-timeout s

run for s seconds then quit

-timeout-motoroff s

quit s seconds after tape motor switches off

-snap-motoroff file

write a snapshot each time tape motor switches off

Help options

-config-print

print configuration to standard out

-config-print-all

print configuration to standard out, including defaults

-h,  --help

display help and exit

-V,  --version

output version information and exit

Files

$HOME/.xroar/xroar.conf

Author

Ciaran Anscomb <xroar@6809.org.uk>

Info

January 2024 XRoar 1.5.5