path: root/games/xroar/xroar.6

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "XROAR 6"
.TH XROAR 6 "2014-08-24" "0.32" "SlackBuilds.org"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
xroar \- Dragon and CoCo 1/2 emulator.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
xroar [\-c \s-1CONFFILE\s0] [\s-1OPTION\s0]...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
XRoar is a Dragon emulator.  Due to hardware similarities, XRoar also emulates the Tandy Colour Computer
(CoCo) models 1 & 2.
.PP
This man page just documents the command-line options to xroar. For full documentation,  see the info page for
xroar, or the \s-1HTML\s0 documentation in /usr/doc/xroar\-_VERSION_/xroar.html.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-c \s-1CONFFILE\s0" 5
.IX Item "-c CONFFILE"
specify a configuration file
.IP "Machines" 5
.IX Item "Machines"
.PD 0
.IP "\-default\-machine \s-1NAME\s0" 5
.IX Item "-default-machine NAME"
.PD
default machine on startup
.IP "\-machine \s-1NAME\s0" 5
.IX Item "-machine NAME"
configure named machine (\fB\-machine help\fR for list)
.IP "\-machine\-desc \s-1TEXT\s0" 5
.IX Item "-machine-desc TEXT"
machine description
.IP "\-machine\-arch \s-1ARCH\s0" 5
.IX Item "-machine-arch ARCH"
machine architecture (\fB\-machine\-arch help\fR for list)
.IP "\-machine\-keyboard \s-1LAYOUT\s0" 5
.IX Item "-machine-keyboard LAYOUT"
keyboard layout (\fB\-machine\-keyboard\fR help for list)
.IP "\-machine\-cpu \s-1CPU\s0" 5
.IX Item "-machine-cpu CPU"
machine \s-1CPU \s0(\fB\-machine\-cpu help\fR for list)
.IP "\-bas \s-1NAME\s0" 5
.IX Item "-bas NAME"
\&\s-1BASIC ROM\s0 to use (CoCo only)
.IP "\-extbas \s-1NAME\s0" 5
.IX Item "-extbas NAME"
Extended \s-1BASIC ROM\s0 to use
.IP "\-altbas \s-1NAME\s0" 5
.IX Item "-altbas NAME"
64K mode Extended \s-1BASIC ROM \s0(Dragon 64)
.IP "\-nobas" 5
.IX Item "-nobas"
disable \s-1BASIC\s0
.IP "\-noextbas" 5
.IX Item "-noextbas"
disable Extended \s-1BASIC\s0
.IP "\-noaltbas" 5
.IX Item "-noaltbas"
disable 64K mode Extended \s-1BASIC\s0
.IP "\-ext\-charset \s-1NAME\s0" 5
.IX Item "-ext-charset NAME"
external character generator \s-1ROM\s0 to use
.IP "\-tv\-type \s-1TYPE\s0" 5
.IX Item "-tv-type TYPE"
\&\s-1TV\s0 type (\fB\-tv\-type help\fR for list)
.IP "\-vdg\-type \s-1TYPE\s0" 5
.IX Item "-vdg-type TYPE"
\&\s-1VDG\s0 type (6847 or 6847t1)
.IP "\-ram \s-1KBYTES\s0" 5
.IX Item "-ram KBYTES"
amount of \s-1RAM\s0 in K
.IP "\-machine\-cart \s-1NAME\s0" 5
.IX Item "-machine-cart NAME"
default cartridge for selected machine
.IP "\-nodos" 5
.IX Item "-nodos"
don't automatically pick a \s-1DOS\s0 cartridge
.IP "Cartridges" 5
.IX Item "Cartridges"
.PD 0
.IP "\-cart \s-1NAME\s0" 5
.IX Item "-cart NAME"
.PD
configure named cartridge (\fB\-cart help\fR for list)
.IP "\-cart\-desc \s-1TEXT\s0" 5
.IX Item "-cart-desc TEXT"
cartridge description
.IP "\-cart\-type \s-1TYPE\s0" 5
.IX Item "-cart-type TYPE"
cartridge base type (\fB\-cart\-type help\fR for list)
.IP "\-cart\-rom \s-1NAME\s0" 5
.IX Item "-cart-rom NAME"
\&\s-1ROM\s0 image to load ($C000\-)
.IP "\-cart\-rom2 \s-1NAME\s0" 5
.IX Item "-cart-rom2 NAME"
second \s-1ROM\s0 image to load ($E000\-)
.IP "\-cart\-autorun" 5
.IX Item "-cart-autorun"
autorun cartridge
.IP "\-cart\-becker" 5
.IX Item "-cart-becker"
enable becker port where supported
.IP "Becker port" 5
.IX Item "Becker port"
.PD 0
.IP "\-becker" 5
.IX Item "-becker"
.PD
prefer becker-enabled \s-1DOS \s0(when picked automatically)
.IP "\-becker\-ip \s-1ADDRESS\s0" 5
.IX Item "-becker-ip ADDRESS"
address or hostname of DriveWire server [127.0.0.1]
.IP "\-becker\-port \s-1PORT\s0" 5
.IX Item "-becker-port PORT"
port of DriveWire server [65504]
.IP "Files" 5
.IX Item "Files"
.PD 0
.IP "\-load \s-1FILENAME\s0" 5
.IX Item "-load FILENAME"
.PD
load or attach \s-1FILENAME\s0
.IP "\-run \s-1FILENAME\s0" 5
.IX Item "-run FILENAME"
load or attach \s-1FILENAME\s0 and attempt autorun
.IP "Cassettes" 5
.IX Item "Cassettes"
.PD 0
.IP "\-tape\-write \s-1FILENAME\s0" 5
.IX Item "-tape-write FILENAME"
.PD
open \s-1FILENAME\s0 for tape writing
.IP "\-no\-tape\-fast" 5
.IX Item "-no-tape-fast"
disable fast tape loading
.IP "\-tape\-pad" 5
.IX Item "-tape-pad"
force tape leader padding
.IP "\-no\-tape\-pad\-auto" 5
.IX Item "-no-tape-pad-auto"
disable automatic leader padding
.IP "\-tape\-rewrite" 5
.IX Item "-tape-rewrite"
enable tape rewriting
.IP "Disks" 5
.IX Item "Disks"
.PD 0
.IP "\-disk\-write\-back" 5
.IX Item "-disk-write-back"
.PD
default to enabling write-back for disk images
.IP "\-no\-disk\-auto\-os9" 5
.IX Item "-no-disk-auto-os9"
don't try to detect headerless \s-1OS\-9 JVC\s0 disk images
.IP "Firmware \s-1ROM\s0 images" 5
.IX Item "Firmware ROM images"
.PD 0
.IP "\-rompath \s-1PATH\s0" 5
.IX Item "-rompath PATH"
.PD
\&\s-1ROM\s0 search path (colon-separated list)
.IP "\-romlist NAME=LIST" 5
.IX Item "-romlist NAME=LIST"
define a \s-1ROM\s0 list
.IP "\-romlist\-print" 5
.IX Item "-romlist-print"
print defined \s-1ROM\s0 lists
.IP "\-crclist NAME=LIST" 5
.IX Item "-crclist NAME=LIST"
define a \s-1ROM CRC\s0 list
.IP "\-crclist\-print" 5
.IX Item "-crclist-print"
print defined \s-1ROM CRC\s0 lists
.IP "\-force\-crc\-match" 5
.IX Item "-force-crc-match"
force per-architecture \s-1CRC\s0 matches
.IP "User interface" 5
.IX Item "User interface"
.PD 0
.IP "\-ui \s-1MODULE\s0" 5
.IX Item "-ui MODULE"
.PD
user-interface module (\fB\-ui help\fR for list)
.IP "Video" 5
.IX Item "Video"
.PD 0
.IP "\-vo \s-1MODULE\s0" 5
.IX Item "-vo MODULE"
.PD
video module (\fB\-vo help\fR for list)
.IP "\-fs" 5
.IX Item "-fs"
start emulator full-screen if possible
.IP "\-fskip \s-1FRAMES\s0" 5
.IX Item "-fskip FRAMES"
frameskip (default: 0)
.IP "\-ccr \s-1RENDERER\s0" 5
.IX Item "-ccr RENDERER"
cross-colour renderer (\fB\-ccr help\fR for list)
.IP "\-geometry WxH+X+Y" 5
.IX Item "-geometry WxH+X+Y"
initial emulator geometry
.IP "\-invert\-text" 5
.IX Item "-invert-text"
start with text mode inverted
.IP "Audio" 5
.IX Item "Audio"
.PD 0
.IP "\-ao \s-1MODULE\s0" 5
.IX Item "-ao MODULE"
.PD
audio module (\fB\-ao help\fR for list)
.IP "\-ao\-device \s-1STRING\s0" 5
.IX Item "-ao-device STRING"
device to use for audio module
.IP "\-ao\-format \s-1FMT\s0" 5
.IX Item "-ao-format FMT"
set audio sample format (\fB\-ao\-format help\fR for list)
.IP "\-ao\-rate \s-1HZ\s0" 5
.IX Item "-ao-rate HZ"
set audio frame rate (if supported by module)
.IP "\-ao\-channels N" 5
.IX Item "-ao-channels N"
set number of audio channels, 1 or 2
.IP "\-ao\-fragments N" 5
.IX Item "-ao-fragments N"
set number of audio fragments
.IP "\-ao\-fragment\-ms \s-1MS\s0" 5
.IX Item "-ao-fragment-ms MS"
set audio fragment size in ms (if supported)
.IP "\-ao\-fragment\-frames N" 5
.IX Item "-ao-fragment-frames N"
set audio fragment size in samples (if supported)
.IP "\-ao\-buffer\-ms \s-1MS\s0" 5
.IX Item "-ao-buffer-ms MS"
set total audio buffer size in ms (if supported)
.IP "\-ao\-buffer\-frames N" 5
.IX Item "-ao-buffer-frames N"
set total audio buffer size in samples (if supported)
.IP "\-volume \s-1VOLUME\s0" 5
.IX Item "-volume VOLUME"
audio volume (0 \- 100)
.IP "\-fast\-sound" 5
.IX Item "-fast-sound"
faster but less accurate sound
.IP "Keyboard" 5
.IX Item "Keyboard"
.PD 0
.IP "\-keymap \s-1CODE\s0" 5
.IX Item "-keymap CODE"
.PD
host keyboard type (\fB\-keymap help\fR for list)
.IP "\-kbd\-translate" 5
.IX Item "-kbd-translate"
enable keyboard translation
.IP "\-type \s-1STRING\s0" 5
.IX Item "-type STRING"
intercept \s-1ROM\s0 calls to type \s-1STRING\s0 into \s-1BASIC\s0
.IP "Joysticks" 5
.IX Item "Joysticks"
See \s-1JOYSTICK SPECS\s0 below for the description of the \s-1SPEC\s0 arguments.
.IP "\-joy \s-1NAME\s0" 5
.IX Item "-joy NAME"
configure named joystick (\fB\-joy help\fR for list)
.IP "\-joy\-desc \s-1TEXT\s0" 5
.IX Item "-joy-desc TEXT"
joystick description
.IP "\-joy\-axis AXIS=SPEC" 5
.IX Item "-joy-axis AXIS=SPEC"
configure joystick axis
.IP "\-joy\-button BTN=SPEC" 5
.IX Item "-joy-button BTN=SPEC"
configure joystick button
.IP "\-joy\-right \s-1NAME\s0" 5
.IX Item "-joy-right NAME"
map right joystick
.IP "\-joy\-left \s-1NAME\s0" 5
.IX Item "-joy-left NAME"
map left joystick
.IP "\-joy\-virtual \s-1NAME\s0" 5
.IX Item "-joy-virtual NAME"
specify the `virtual' joystick to cycle [kjoy0]
.IP "Printing" 5
.IX Item "Printing"
.PD 0
.IP "\-lp\-file \s-1FILENAME\s0" 5
.IX Item "-lp-file FILENAME"
.PD
append Dragon printer output to \s-1FILENAME\s0
.IP "\-lp\-pipe \s-1COMMAND\s0" 5
.IX Item "-lp-pipe COMMAND"
pipe Dragon printer output to \s-1COMMAND\s0
.IP "Debugging" 5
.IX Item "Debugging"
.PD 0
.IP "\-gdb" 5
.IX Item "-gdb"
.PD
disable \s-1GDB\s0 target
.IP "\-gdb\-ip" 5
.IX Item "-gdb-ip"
address of interface for \s-1GDB\s0 target [localhost]
.IP "\-gdb\-port" 5
.IX Item "-gdb-port"
port for \s-1GDB\s0 target to listen on [65520]
.IP "\-trace" 5
.IX Item "-trace"
start with trace mode on
.IP "\-debug\-ui \s-1FLAGS\s0" 5
.IX Item "-debug-ui FLAGS"
\&\s-1UI\s0 debugging (see manual, or \-1 for all)
.IP "\-debug\-file \s-1FLAGS\s0" 5
.IX Item "-debug-file FLAGS"
file debugging (see manual, or \-1 for all)
.IP "\-debug\-fdc \s-1FLAGS\s0" 5
.IX Item "-debug-fdc FLAGS"
\&\s-1FDC\s0 debugging (see manual, or \-1 for all)
.IP "\-debug\-gdb \s-1FLAGS\s0" 5
.IX Item "-debug-gdb FLAGS"
\&\s-1GDB\s0 target debugging (see manual, or \-1 for all)
.IP "\-v, verbose \s-1LEVEL\s0" 5
.IX Item "-v, verbose LEVEL"
general debug verbosity (0\-3) [1]
.IP "\-q, \-\-quiet" 5
.IX Item "-q, --quiet"
equivalent to \-\-verbose 0
.IP "\-timeout \s-1SECONDS\s0" 5
.IX Item "-timeout SECONDS"
run for \s-1SECONDS\s0 then quit
.SH "Other options"
.IX Header "Other options"
.IP "\-config\-print" 5
.IX Item "-config-print"
print full configuration to standard output
.IP "\-h, \-\-help" 5
.IX Item "-h, --help"
display this help and exit
.IP "\-V, \-\-version" 5
.IX Item "-V, --version"
output version information and exit
.SH "JOYSTICK SPECS"
.IX Header "JOYSTICK SPECS"
Joystick SPECs are of the form [\s-1INTERFACE:\s0][ARG[,ARG]...], from:
.PP
.Vb 1
\&        INTERFACE       Axis ARGs                       Button ARGs
\&
\&        physical        joystick\-index,[\-]axis\-index    joystick\-index,button\-index
\&        keyboard        key\-name0,key\-name1             key\-name
\&        mouse           screen\-offset0,screen\-offset1   button\-number
.Ve
.PP
For physical joysticks a `\-' before the axis index inverts the axis.  \s-1AXIS 0\s0 is the X\-axis, and \s-1AXIS 1\s0 the
Y\-axis.  \s-1BTN 0\s0 is the only one used so far, but in the future \s-1BTN 1\s0 will be the second button on certain CoCo
joysticks.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
xroar is Copyright (c) 2009 Ciaran Anscomb
.PP
This man page written by B. Watson for the SlackBuilds.org project (but it may be used by anyone).
.PP
This is free software.  You may redistribute copies of it under the terms of the \s-1GNU\s0 General Public License
<http://www.gnu.org/licenses/gpl.html>.  There is \s-1NO WARRANTY,\s0 to the extent permitted by law.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The info page for xroar (includes much information not found in this man page).
.PP
http://en.wikipedia.org/wiki/TRS\-80_Color_Computer
.PP
http://archive.worldofdragon.org/index.php?title=Main_Page
.PP
http://archive.worldofdragon.org/archive/index.php