.\" -*- nroff -*-
.\"
.\" fuse.1: Fuse man page
.\" Copyright (c) 2001-2007 Russell Marks, Philip Kendall, Darren Salt,
.\"                         Fredrick Meunier
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
.\"
.\" Author contact information:
.\"
.\" E-mail: philip-fuse@shadowmagic.org.uk
.\"
.\"
.TH fuse 1 "11th May, 2007" "Version 0.8.0.1" "Emulators"
.\"
.\"------------------------------------------------------------------
.\"
.SH NAME
fuse \- Sinclair ZX Spectrum emulator
.\"
.\"------------------------------------------------------------------
.\"
.SH SYNOPSIS
.\" the trend for long-option-using programs is to give a largely
.\" generic synopsis, so...
.PD 0
.B fuse
.RI [ options ]
.P
.PD 1
.\"
.\"------------------------------------------------------------------
.\"
.SH DESCRIPTION
Fuse is a Sinclair ZX Spectrum emulator. It supports several models
(including the 128), with quite faithful emulation of the display and
sound.
.PP
The emulator can load any of the formats supported by
.IR libspectrum (3)
- this includes Z80, SNA and SZX snapshots, and TAP and TZX
virtual-tape files. Saving to SZX, Z80 and SNA snapshots and TZX and
TAP tape files is supported. The SLT extension to the Z80 format is
partly supported (enough for multi-load games); however, loading of
the old DAT-file variant is not. DSK disk images are supported when
emulating a +3, TRD and SCL disk images are supported when emulating
a Pentagon or Scorpion and DCK cartridge images are supported when
emulating a Timex 2068 variant. Interface II ROM cartridges are also
supported.
.PP
Finally, there is also support for reading and writing the RZX input recording
format.
.PP
See the
.B COMPRESSED FILES
section for details on reading files compressed with
.IR bzip2 "(3)"
or
.IR gzip "(3)."
.\"
.\"------------------------------------------------------------------
.\"
.SH OPTIONS
.\" dual short/long option listings here reflect the GNU approach,
.\" as used in info files. It does mean using RS/RE, though,
.\" so this is used for all options (for consistency).
.\"
.\" the options list is in alphabetical order by long option name (or
.\" short option name if none).
.\"
.I \-\-aspect\-hint
.RS
Specify whether the GTK+ and Xlib user interfaces should `hint' to the
window manager about the preferred aspect ratio for the graphics
window, thus preventing resizing to non-square sizes which lead to
Fuse not displaying correctly. This option has been observed to cause
problems with some window managers when using the GTK+ UI which can
prevent the window from being resized or moved at all. (Enabled by
default, but you can use
.RI ` \-\-no\-aspect\-hint '
to disable). See also the
.RI ` \-\-strict\-aspect\-hint ' option.
.RE
.PP
.I \-\-autosave\-settings
.RS
Specify whether Fuse's current settings should be automatically saved
on exit. The same as the General Options dialog's
.I "Auto-save settings"
option.
.RE
.PP
.I \-\-auto\-load
.RS
Specify whether tape and disk files should be automatically loaded
when they are opened. (Enabled by default, but you can use
.RI ` \-\-no\-auto\-load '
to disable). Same as the General Options dialog's
.I "Auto-load media"
option.
.RE
.PP
.I \-\-beeper\-stereo
.RS
Specify whether fake stereo should be added to the emulation of the
Spectrum beeper. Same as the Sound Option dialog's
.I "Beeper pseudo-stereo"
option.
.RE
.PP
.I \-\-bw\-tv
.RS
Specify whether the display should simulate a colour or black and
white television. This option is effective only under the GTK+ and SDL
user interfaces: the others will always simulate a colour TV. The same
as the General Option dialog's
.I "Black and white TV"
option.
.RE
.PP
.I "\-\-competition\-code code"
.RS
Specify the code to be written to competition mode RZX files. The same
as the RZX Options dialog's
.I "Competition code"
option.
.RE
.PP
.I \-\-competition\-mode
.RS
Specify whether input recordings should be made in `competition mode'.
The same as the RZX Options dialog's
.I "Competition mode"
option.
.RE
.PP
.I \-\-compress\-rzx
.RS
Specify whether RZX files should be written out compressed. (Enabled
by default, but you can use
.RI ` \-\-no\-compress\-rzx '
to disable). Same as the RZX Options dialog's
.I "Compress RZX data"
option.
.RE
.PP
.I "\-\-confirm\-actions"
.RS
Specify whether `dangerous' actions (those which could cause data
loss, for example resetting the Spectrum) require confirmation before
occuring. (Enabled by default, but you can use
.RI ` \-\-no\-confirm\-actions'
to disable). This option is effective only under the GTK+ UI, and is
the same as the General Options dialog's
.I "Confirm actions"
option.
.RE
.PP
.I "\-\-detect\-loader"
.RS
Specify whether Fuse should attempt to detect when the tape is being
accessed and start and stop the virtual tape playing
automatically. (Enabled by default, but you can use
.RI ` \-\-no\-detect\-loader'
to disable). Same as the General Option dialog's
.I "Detect loaders"
option.
.RE
.PP
.I "\-\-dock file"
.RS
Insert the specified file into the emulated Timex 2068 variant dock;
also select the TC2068 on startup if available.
.RE
.PP
.I "\-\-embed\-snapshot"
.RS
Specify whether a snapshot should be embedded in an RZX file when
recording is started from an existing snapshot. (Enabled by default,
but you can use
.RI ` \-\-no\-embed\-snapshot '
to disable). Same as the RZX Options dialog's
.I "Always embed snapshot"
option.
.RE
.PP
.I "\-\-fastload"
.RS
Specify whether Fuse should run at the fastest possible speed when the
virtual tape is playing. (Enabled by default, but you can use
.RI ` \-\-no\-fastload'
to disable). The same as the General Option dialog's
.I "Fastloading"
option.
.RE
.PP
.I "\-f frequency"
.br
.I "\-\-sound\-freq frequency"
.RS
Specify what frequency Fuse should use for the sound
device, the default is 32KHz, but some devices only
support a single frequency or a limited range (e.g.
48KHz or up to 22KHz).
.RE
.PP
.I "\-\-full\-screen"
.RS
Specify whether Fuse should run in full screen mode.
This option is effective only under the SDL UI.
.RE
.PP
.I "\-g filter"
.br
.I "\-\-graphics\-filter mode"
.RS
Specify which graphics filter to use if available. The default is
.IR normal ,
which uses no filtering. The available options are
.IR 2x ,
.IR 2xsai ,
.IR 3x ,
.IR advmame2x ,
.IR advmame3x ,
.IR dotmatrix ,
.IR half ,
.IR halfskip ,
.IR normal ,
.IR super2xsai ,
.IR supereagle ,
.IR timex15x ,
.IR timextv ,
.IR tv2x ,
.IR paltv ,
.IR paltv2x ,
and
.IR paltv3x .
See the
.B "GRAPHICS FILTERS"
section for more details.
.RE
.PP
.I "\-\-graphicsfile file"
.RS
Set the filename used for graphical output from the emulated ZX
printer. See the
.B "PRINTER EMULATION"
section for more details.
.RE
.PP
.I \-h
.br
.I \-\-help
.RS
Give brief usage help, listing available options.
.RE
.PP
.I "\-\-if2cart file"
.RS
Insert the specified file into the emulated Interface II.
.RE
.PP
.I \-\-interface1
.RS
Emulate a Sinclair Interface I. Same as the Peripherals Options dialog's
.I "Interface I"
option.
.RE
.PP
.I \-\-interface2
.RS
Emulate a Sinclair Interface II. Same as the Peripherals Options dialog's
.I "Interface II"
option.
.RE
.PP
.I \-\-issue2
.RS
Emulate an issue 2 keyboard. Same as the General Options dialog's
.I "Issue 2 keyboard"
option.
.RE
.PP
.I "\-j device"
.br
.I "\-\-joystick\-1 device"
.RS
Read from
.I device
to emulate the first joystick. Fuse will use either
.RI ` /dev/input/js0 '
or
.RI ` /dev/js0 '
by default.
.RE
.PP
.I "\-\-joystick\-2 device"
.RS
As for
.I \-\-joystick\-1
but for the second joystick; the default here is either
.RI ` /dev/input/js1 '
or
.RI ` /dev/js1 "'."
.RE
.PP
.I \-\-kempston
.RS
Emulate a Kempston joystick. Same as the Peripherals Options dialog's
.I "Kempston joystick"
option.
.RE
.PP
.I \-\-kempston\-mouse
.RS
Emulate a Kempston mouse. Same as the Peripherals Options dialog's
.I "Kempston mouse"
option.
.RE
.PP
.I \-\-loading\-sound
.RS
Specify whether the sound made while tapes are loading should be
emulated. (Enabled by default, but you can use
.RI ` \-\-no\-loading\-sound '
to disable). Same as the Sound Option dialog's
.I "Loading sound"
option.
.RE
.PP
.I "\-m type"
.br
.I "\-\-machine type"
.RS
Specify machine type to emulate initially. The default is
.IR 48 ,
a 48K Spectrum. The available options are
.IR 16 ,
.IR 48 ,
.IR 128 ,
.IR plus2 ,
.IR plus2a ,
.IR plus3 ,
.IR 2048 ,
.IR 2068 ,
.IR ts2068 ,
.IR pentagon ,
and
.IR scorpion .
.RE
.PP
.I "\-p file"
.br
.I "\-\-playback file"
.RS
Specify an RZX file to begin playback from.
.RE
.PP
.I \-\-paltv2x
.RS
Specify whether the PAL TV 2x and PAL TV 3x scalers should also produce
scanlines along the lines of the TV 2x and Timex TV scalers.
The same as the General Options dialog's
.I "PAL-TV use TV2x effect"
option.
.RE
.PP
.I "\-\-plus3disk file"
.RS
Insert the specified file into the emulated +3's A: drive; also select
the +3 on startup if available.
.RE
.PP
.I "\-\-printer"
.RS
Specify whether the emulation should include a printer. Same as the
Peripherals Options dialog's
.I "Emulate printers"
option.
.RE
.PP
.I "\-\-rate frame"
.RS
Specify the frame rate, the ratio of spectrum frame updates to real
frame updates. Same as the General Options dialog's
.I "Frame rate"
option.
.RE
.PP
.I "\-r file"
.br
.I "\-\-record file"
.RS
Specify an RZX file to begin recording to.
.RE
.PP
.I "\-\-rom\-16 file"
.br
.I "\-\-rom\-48 file"
.br
.I "\-\-rom\-128-0 file"
.br
.I "\-\-rom\-128-1 file"
.br
.I "\-\-rom\-plus2-0 file"
.br
.I "\-\-rom\-plus2-1 file"
.br
.I "\-\-rom\-plus2a-0 file"
.br
.I "\-\-rom\-plus2a-1 file"
.br
.I "\-\-rom\-plus2a-2 file"
.br
.I "\-\-rom\-plus2a-3 file"
.br
.I "\-\-rom\-plus3-0 file"
.br
.I "\-\-rom\-plus3-1 file"
.br
.I "\-\-rom\-plus3-2 file"
.br
.I "\-\-rom\-plus3-3 file"
.br
.I "\-\-rom\-plus3e-0 file"
.br
.I "\-\-rom\-plus3e-1 file"
.br
.I "\-\-rom\-plus3e-2 file"
.br
.I "\-\-rom\-plus3e-3 file"
.br
.I "\-\-rom\-tc2048 file"
.br
.I "\-\-rom\-tc2068-0 file"
.br
.I "\-\-rom\-tc2068-1 file"
.br
.I "\-\-rom\-ts2068-0 file"
.br
.I "\-\-rom\-ts2068-1 file"
.br
.I "\-\-rom\-pentagon-0 file"
.br
.I "\-\-rom\-pentagon-1 file"
.br
.I "\-\-rom\-pentagon-2 file"
.br
.I "\-\-rom\-scorpion-0 file"
.br
.I "\-\-rom\-scorpion-1 file"
.br
.I "\-\-rom\-scorpion-2 file"
.br
.I "\-\-rom\-scorpion-3 file"
.br
.I "\-\-rom\-spec-se-0 file"
.br
.I "\-\-rom\-spec-se-1 file"
.br
.I "\-\-rom\-interface-1 file"
.RS
Specify the file to be used for ROM(s) used for each machine. The
options respectively refer to the 16K Spectrum
.RI ( 48.rom ),
48K Spectrum
.RI ( 48.rom ),
the two ROMs for the 128K Spectrum
.RI ( 128-0.rom " and " 128-1.rom ),
the two ROMs for the +2
.RI ( plus2-0.rom " and " plus2-1.rom ),
the four ROMs for the +2A
.RI ( plus3-0.rom ", " plus3-1.rom ", " plus3-2.rom " and " plus3-3.rom ),
the four ROMs for the +3
.RI ( plus3-0.rom ", " plus3-1.rom ", " plus3-2.rom " and " plus3-3.rom ),
the TC2048 ROM
.RI ( tc2048.rom ),
the two ROMs for the TC2068
.RI ( tc2068-0.rom " and " tc2068-1.rom ),
the two ROMs for the TS2068
.RI ( tc2068-0.rom " and " tc2068-1.rom ),
the two main ROMs and the TR-DOS ROM for the Pentagon 128
.RI ( 128p-0.rom ", " 128p-1.rom " and " trdos.rom ),
the four ROMs for the Scorpion 256
.RI ( 256s-0.rom ", " 256s-1.rom ", " 256s-2.rom " and " 256s-3.rom ),
the two ROMs for the Spectrum SE
.RI ( se-0.rom " and " se-1.rom ),
and the Interface I ROM
.RI ( if1-2.rom ).
The names in brackets denote the defaults.
.RE
.PP
.I \-\-separation
.RS
Give stereo separation of the 128's AY sound channels. Same as the
General Options dialog's
.I "AY stereo separation"
option.
.RE
.PP
.I \-\-simpleide
.RS
Specify whether Fuse will emulate the simple 8-bit IDE interface
as used by the Spectrum +3e. Same as the Perpherals
Option dialog's
.I "Simple 8-bit IDE"
option.
.RE
.PP
.I \-\-simpleide\-masterfile file
.RS
Specify a HDF file to connect to the emulated Simple 8-bit IDE
interface's master channel.
.RE
.PP
.I \-\-simpleide\-slavefile file
.RS
Specify a HDF file to connect to the emulated Simple 8-bit IDE
interface's slave channel.
.RE
.PP
.I \-\-slt
.RS
Support the SLT trap instruction. (Enabled by default, but you can use
.RI ` \-\-no\-slt '
to disable). Same as the General Options dialog's
.I "Use .slt traps"
option.
.RE
.PP
.I "\-s file"
.br
.I "\-\-snapshot file"
.RS
Specify a snapshot file to load. The file can be in any snapshot
format supported by
.IR libspectrum "(3)."
.RE
.PP
.I \-\-snaps\-as\-z80
.RS
Specify whether the widget based user interfaces should save snapshots
as .szx or .z80 files. The same as the General Options dialog's
.I "Save snaps as .z80"
option.
.RE
.PP
.I \-\-sound
.RS
Specify whether Fuse should produce sound. (Enabled by default, but
you can use
.RI ` \-\-no\-sound '
to disable). Same as the Sound Option dialog's
.I "Sound enabled"
option.
.RE
.PP
.I \-\-sound\-force\-8bit
.RS
Force the use of 8-bit sound, even if 16-bit is possible. Same as the
Sound Option dialog's
.I "Force 8-bit"
option.
.RE
.PP
.I "\-d device"
.br
.I "\-\-sound\-device device"
.RS
Specify the sound output device to use and any options to give that
device. If you are not using the SDL UI or using
.I libao
for sound output,
then the
.I "device"
parameter just specifies the device to be used for sound output.
.PP
If you are using the SDL UI, the
.I "device"
parameter allows you to specify the
audio driver to be used (e.g. dsp, alsa, dma, esd and arts).
.PP
If you are using
.I libao
for sound output, the
.I "device"
parameter allows you to specify the device used for sound output
(either `live' to a speaker or to a file) and the parameters to be
used for that device. In general, the
.I "device"
parameter has the form
.IR driver[:param[=value][,param[=value][,...]] .
.I "driver"
selects the libao driver to be used, either one of the `live' drivers
.RI ( aixs ", " alsa ", " alsa09 ", " arts ", " esd ", " irix
.RI  ", " macosx ", " nas ", " oss " or " sun )
or a file driver
.RI ( au ", " raw ", " wav " or " null ).
The available parameter and value pairs for each device are:
.IP \[bu]
.IR aixs :
AIX audio system
.RS
.IP \[bu]
.RI dev= device
.br
.RI ` device '
gives the AIX sound device.
.RE
.IP \[bu]
.IR alsa :
Advanced Linux Sound Architecture version 0.5.x
.RS
.IP \[bu]
.RI card= num
.br
.RI ` num '
gives the ALSA card number.
.IP \[bu]
.RI dev= num
.br
.RI ` num '
gives the ALSA device number.
.IP \[bu]
.RI buf_size= num
.br
.RI ` num '
gives the ALSA buffer size in bytes.
.RE
.IP \[bu]
.IR alsa09 :
Advanced Linux Sound Architecture version 0.9+
.RS
.IP \[bu]
.RI dev= string
.br
.RI ` string '
specfies the ALSA device e.g. hw:1.2
.IP \[bu]
.RI buffer_time= num
.br
.RI ` num '
gives the ALSA buffer time in microseconds.
.IP \[bu]
.RI period_time= num
.br
.RI ` num '
gives the ALSA period time in microseconds.
.IP \[bu]
.RI use_mmap= yes|y|true|t|1
.br
specifies that libao use memory mapped transfer.
.RE
.IP \[bu]
.IR arts :
aRts soundserver: no parameters.
.IP \[bu]
.IR esd :
Enlightened Sound Daemon.
.RS
.IP \[bu]
.RI host= string
.br
.RI ` string '
gives the ESD host specification.
.RE
.IP \[bu]
.IR irix :
IRIX Audio Library: no parameters.
.IP \[bu]
.IR macosx :
MacOS X CoreAudio: no parameters.
.IP \[bu]
.IR nas :
Network Audio System.
.RS
.IP \[bu]
.RI host= string
.br
.RI ` string '
gives the NAS host specification.
.IP \[bu]
.RI buf_size= num
.br
.RI ` num '
gives the buffer size on the server.
.RE
.IP \[bu]
.IR oss :
Open Sound System.
.RS
.IP \[bu]
.RI dsp= string
.br
.RI ` string '
gives the OSS device to be used e.g. /dev/sound/dsp1
.RE
.IP \[bu]
.IR sun :
SUN audio system.
.RS
.IP \[bu]
.RI dev= string
.br
.RI ` string '
gives the audio device to be used.
.RE
.IP \[bu]
.IR au :
SUN Sparc audio file: no parameters.
.IP \[bu]
.IR raw :
raw file.
.RS
.IP \[bu]
.RI byteorder= string
.br
.RI ` string '
can be any of
.I native
(host native byteorder),
.I big
(big endian) or
.I little
(little endian).
.RE
.IP \[bu]
.IR wav :
Microsoft audio file: no parameters.
.IP \[bu]
.IR null :
null output: no parameters.
.IP \[bu]
.RI debug :
for debugging libao.
.PP
Finally, each of the file output types
.RI ( au ", " raw " and " wav )
have an extra option
.RI `file= filename '
where
.RI ` filename '
gives the file output will be directed to. This defaults to
.RI ` fuse-sound.ao '
if it is not specified.
.PP
Some examples of use:
.PP
.I fuse -d alsa09:dev=hw:1
.PP
causes Fuse to use ALSA 0.9+ output with the second (#1) sound card.
.PP
.I fuse -d raw:byteorder=little,file=enigma.raw
.PP
causes Fuse to save little endian words to
.RI ` enigma.raw "'."
.PP
See the `DEVICE' section of
.I ogg123(1)
for up to date information of devices and options (except for the
`file' option which is provided by Fuse itself).
.RE
.PP
.I "\-\-speed percentage"
.RS
Specify the speed (as a percentage of real Spectrum speed) at which
emulation should attempt to proceed. Same as the General Options
dialog's
.I "Emulation speed"
option.
.RE
.PP
.I "\-\-statusbar"
.RS
For the GTK+ UI, enables the statusbar beneath the display. For the
SDL UI, enables the status icons showing whether the disk and tape are
being accessed. Same as the General Options dialog's
.I "Show statusbar"
option.
.RE
.PP
.I "\-\-strict\-aspect\-hint"
.RS
For the GTK+ UI, use stricter limits for the aspect ratio limits set
by the
.RI ` \-\-aspect\-hint ' 
option. This can cause some window managers (for example,
.IR metacity (1))
to not allow the window to be resized and moved, but is necessary to
prevent others (for example,
.IR fvwm (1))
from being able resize the window away from square.
.RE
.PP
.I "\-v mode"
.br
.I "\-\-svgamode mode"
.RS
Specify which mode to use for the SVGAlib and FB UIs. Available values for
.I mode
are `320' (which corresponds to a 320x240x256 mode), the default and
`640' (a 640x480x256 mode).
.RE
.PP
.I "\-D mode"
.br
.I "\-\-doublescan\-mode mode"
.RS
Specify whether to use doublescan modes in the SVGALib and FB UIs.
Available values for
.I mode
are 0, 1 and 2. 0 means "never doublescan" (use 640x480 at either 72Hz or
60Hz), whereas 1 and 2 both mean "try to use doublescan" and will fall back
on the 640x480 modes. These latter two are treated identically for SVGA, but
for FB, they differ: 1 selects 72Hz modes (the same size and shape as your
typical 640x480), and 2 selects 60Hz modes (overscan).
.br
If your monitor displays a blank screen when using 1 or 2, press F10 then
try a different option or say "\-\-svgamode 640".
.RE
.PP
.I "\-t file"
.br
.I "\-\-tape file"
.RS
Specify a virtual tape file to use. It must be in TAP or TZX format.
.RE
.PP
.I "\-\-textfile file"
.RS
Set the filename used for text output from the emulated printers. See
the
.B "PRINTER EMULATION"
section below for more details.
.RE
.PP
.I \-\-traps
.RS
Support traps for ROM tape loading/saving. (Enabled by default, but
you can use
.RI ` \-\-no\-traps '
to disable). Same as the General Options dialog's
.I "Use tape traps"
option.
.RE
.PP
.I "\-\-trdosdisk file"
.RS
Insert the specified file into the emulated TR-DOS drive A: and select
Pentagon mode on startup.
.RE
.PP
.I \-V
.br
.I \-\-version
.RS
Show which version of Fuse is being used.
.RE
.PP
.I \-\-writable\-roms
.RS
Allow Spectrum programs to overwrite the ROM(s). The same as the
General Options dialog's
.I "Allow writes to ROM"
option.
.RE
.PP
.I \-\-zxatasp
.RS
Specify whether Fuse emulate the ZXATASP interface. Same as the
Perpherals Option dialog's
.I "ZXATASP interface"
option.
.RE
.PP
.I \-\-zxatasp\-upload
.RS
Specify the state of the ZXATASP upload jumper. Same as the
Perpherals Option dialog's
.I "ZXATASP upload"
option.
.RE
.PP
.I \-\-zxatasp\-write\-protect
.RS
Specify the state of the ZXATASP write protect jumper. Same as the
Perpherals Option dialog's
.I "ZXATASP write protect"
option.
.RE
.PP
.I \-\-zxatasp\-masterfile file
.RS
Specify a HDF file to connect to the emulated ZXATASP interface's
master channel.
.RE
.PP
.I \-\-zxatasp\-slavefile file
.RS
Specify a HDF file to connect to the emulated ZXATASP interface's
slave channel.
.RE
.PP
.I \-\-zxcf
.RS
Specify whether Fuse emulate the ZXCF interface. Same as the
Perpherals Option dialog's
.I "ZXCF interface"
option.
.RE
.PP
.I \-\-zxcf\-upload
.RS
Specify the state of the ZXCF upload jumper. Same as the Perpherals
Option dialog's
.I "ZXCF upload"
option.
.RE
.PP
.I \-\-zxcf\-cffile file
.RS
Specify a HDF file to connect to the emulated ZXCF interface.
.RE
.PP
All long options which control on/off settings can be disabled using
.RI ` \-\-no\-foo '
(for an option
.RI ` \-\-foo ').
For example, the opposite of
.RI ` \-\-issue2 '
is
.RI ` \-\-no\-issue2 '.
These options can also be modified while the emulator is running,
using the options dialogs - see the documentation for the
.I Options
menu in the
.B "MENUS AND KEYS"
section for details.
.\"
.\"------------------------------------------------------------------
.\"
.SH "THE VARIOUS FRONT-ENDS"
Fuse supports various front-ends, or UIs (user interfaces). The usual
one is GTK+-based, but there are also SDL, Xlib, svgalib and
framebuffer ones.
.PP
The important difference to note is that the GTK+ version uses
`native' dialog boxes etc. (behaving like a fairly normal GUI-based
program) while the others use an alternative, Fuse-specific `widget
UI'. This latter front-end is easily spotted by the way it uses the
main Fuse window/screen for menus and dialogs, and uses the Spectrum's
own font.
.\"
.\"------------------------------------------------------------------
.\"
.SH "MENUS AND KEYS"
Since many of the keys available are devoted to emulation of the
Spectrum's keyboard, the primary way of controlling Fuse itself
(rather than the emulated machine) is via the menus. There are also
function key shortcuts for some menu options.
.PP
In the GTK+ version, the menu bar is always visible at the top of the
Fuse window. You can click on a menu name to pop it up. Alternatively,
you can press
.I F1
to display a pop-up version of the menu bar, which you can then
navigate with the cursor keys or mouse.
.PP
In the widget UI pressing
.I F1
is the only way to get the main menu; and unlike the GTK+ version, the
emulator pauses while the menus are being navigated. The menus show
which key to press for each menu option in brackets. Pressing
.I Esc
exits a menu, and pressing
.I Enter
exits the menu system entirely (as well as `confirming' any current
dialog).
.PP
Here's what the menu options do, along with the function key mappings
for those items which have them:
.PP
.\" function keys are listed first, by analogy with short options
.\" being listed the same way.
.\"
.I F3
.br
.I "File, Open..."
.RS
Open a Spectrum file. Snapshots will be loaded into memory; tape
images will be inserted into the emulated tape deck, and if the
.I "Auto-load media"
option is set will being loading. Opening a disk image or a Timex dock
image will cause the appropriate machine type (+3, Pentagon or TC2068)
to be selected with the image inserted, and disks will automatically
load if the
.I "Auto-load media"
option is set. See the
.B "FILE SELECTION"
section below for details on how to choose the file. Note that this
behaviour is different from previous versions of Fuse, when this
option would open only snapshots.
.RE
.PP
.I F2
.br
.I "File, Save Snapshot..."
.RS
Save a snapshot (machine state, memory contents, etc.) to file. You
can select the filename to be saved to. If it has a .szx, .z80 or .sna
extension, the snapshot will be saved in that format. Otherwise, it
will be saved as a .szx file.
.RE
.PP
.I "File, Recording, Record..."
.RS
Start recording input to an RZX file, initialised from the current
emulation state. You will be prompted for a filename to use.
.RE
.PP
.I "File, Recording, Record from snapshot..."
.RS
Start recording input to an RZX file, initialised from a snapshot. You
will first be asked for the snapshot to use and then the file to save
the recording to.
.RE
.PP
.I Insert
.br
.I "File, Recording, Insert snapshot"
.RS
Inserts a snapshot of the current state into the RZX file. This can
be used at a later point to roll back to the inserted state by using
one of the commands below.
.RE
.PP
.I Delete
.br
.I "File, Recording, Rollback"
.RS
Rolls back the recording to the point at which the previous snapshot
was inserted. Recording will continue from that point.
.RE
.PP
.I "File, Recording, Rollback to..."
.RS
Roll back the recording to any snapshot which has been inserted into
the recording.
.RE
.PP
.I "File, Recording, Play..."
.RS
Playback recorded input from an RZX file. This lets you replay
keypresses recorded previously. RZX files generally contain a snapshot
with the Spectrum's state at the start of the recording; if the
selected RZX file doesn't, you'll be prompted for a snapshot to load
as well.
.RE
.PP
.I "File, Recording, Stop"
.RS
Stop any currently-recording/playing RZX file.
.RE
.PP
.I "File, AY Logging, Record..."
.RS
Start recording the bytes output via the AY-3-8192 sound chip to a PSG
file. You will be prompted for a filename to save the recording to.
.RE
.PP
.I "File, AY Logging, Stop"
.RS
Stop any current AY logging.
.RE
.PP
.I "File, Open SCR Screenshot..."
.RS
Load an SCR screenshot (essentially just a binary dump of the
Spectrum's video memory) onto the current screen. Fuse supports
screenshots saved in the Timex hi-colour and hi-res modes as well as
`normal' Spectrum screens, and will make a simple conversion if a
hi-colour or hi-res screenshot is loaded onto a non-Timex machine.
.RE
.PP
.I "File, Save Screen as SCR..."
.RS
Save a copy of whatever's currently displayed on the Spectrum's screen
as an SCR file. You will be prompted for a filename to save the
screenshot to.
.RE
.PP
.I "File, Save Screen as PNG..."
.RS
Save the current screen as a PNG file. You will be prompted for a
filename to save the screenshot to.
.RE
.PP
.I "File, Movies, Record Movie as SCR..."
.RS
Start recording a `movie' as a series of SCR screenshots. You will be
prompted for a filename, and the screenshots will then be saved to
.RI ` <name>\-frame\-000000000.scr "', `" <name>\-frame\-000000001.scr '
and so on.
.RE
.PP
.I "File, Movies, Record Movie as PNG..."
.RS
Start recording a `movie' as a series of PNG images. The filenames used will be the same as for the SCR movie, but with a
.RI ` .png '
extension instead of
.RI ` .scr '.
.RE
.PP
.I "File, Movies, Stop Movie Recording"
.RS
Stop any movie recording which is currently in progress.
.RE
.PP
.I "File, Load Binary Data..."
.RS
Load binary data from a file into the Spectrum's memory. After
selecting the file to load data from, you can choose where to load the
data and how much data to load.
.RE
.PP
.I "File, Save Binary Data..."
.RS
Save an arbitrary chunk of the Spectrum's memory to a file. Select the
file you wish to save to, followed by the location and length of data
you wish to save.
.RE
.PP
.I F10
.br
.I "File, Exit"
.RS
Exit the emulator. A confirmation dialog will appear checking you
actually want to do this.
.RE
.PP
.I F4
.br
.I "Options, General..."
.RS
Display the General Options dialog, letting you configure Fuse. (With
the widget UI, the keys shown in brackets toggle the options,
.I Enter
confirms any changes, and
.I Esc
aborts). Note that any changed settings only apply to the
currently-running Fuse.
.PP
The options available are:
.PP
.I "Emulation speed"
.RS
Set how fast Fuse will attempt to emulate the Spectrum, as a
percentage of the speed at which the real machine runs. If your
machine isn't fast enough to keep up with the requested speed, Fuse
will just run as fast as it can. Note that if the emulation speed is
not exactly 100%, no sound output will be produced.
.RE
.PP
.I "Frame rate"
.RS
Specify the frame rate, the ratio of spectrum frame updates to real
frame updates. This is useful if your machine is having trouble keeping
up with the spectrum screen updates.
.RE
.PP
.I "Issue 2 keyboard"
.RS
Early versions of the Spectrum used a different value for unused bits
on the keyboard input ports, and a few games depended on the old value
of these bits. Enabling this option switches to the old value, to let
you run them.
.RE
.PP
.I "Use tape traps"
.RS
Ordinarily, Fuse intercepts calls to the ROM tape-loading routine in
order to load from tape files more quickly when possible. But this can
(rarely) interfere with TZX loading; disabling this option avoids the
problem at the cost of slower (i.e. always real-time) tape-loading.
When tape-loading traps are disabled, you need to start tape playback
manually, by pressing
.I F8
or choosing the
.I "Media, Tape, Play"
menu item.
.RE
.PP
.I "Fastloading"
.RS
If this option is enabled, then Fuse will run at the fastest possible
speed when the virtual tape is playing, thus dramatically reducing the
time it takes to load programs. You may wish to disable this option if
you wish to stop the tape at a specific point.
.RE
.PP
.I "Detect loaders"
.RS
If this option is enabled, Fuse will attempt to detect when a loading
routine is in progress, and then automatically start the virtual tape
to load the program in. This is done by using a heuristic to identify
a loading routine, so is by no means infalliable, but works in most
cases.
.RE
.PP
.I "Auto-load media"
.RS
On many occasions when you open a tape or disk file, it's because it's
got a program in you want to load and run. If this option is selected,
this will automatically happen for you when you open one of these
files. To use tapes or disks for saving data to, or for loading data
into an already running program, you'll want to turn this option off.
.RE
.PP
.I "Use .slt traps"
.RS
The multi-load aspect of SLT files requires a trap instruction to be
supported. This instruction is not generally used except for this
trap, but since it's not inconceivable that a program could be wanting
to use the real instruction instead, you can choose whether to support
the trap or not.
.RE
.PP
.I "Allow writes to ROM"
.RS
If this option is selected, Fuse will happily allow programs to
overwrite what would normally be ROM. This probably isn't very useful
in most circumstances, especially as the 48K ROM overwrites parts of
itself.
.RE
.PP
.I "Auto-save settings"
.RS
If this option is selected, Fuse will automatically write its
currently selected options to its configuration file on exit (if
.I libxml2
was available when Fuse was compiled). If you turn this option off,
you'll have to manually use
.I "Options, Save"
afterwards to ensure that this setting gets written to Fuse's
configuration file.
.RE
.PP
.I "MDR cartridge len"
.RS
This option controls the number of blocks in a new microdrive cartridge.
0 means select a random capacity, otherwise selects the number of blocks
available.
.RE
.PP
.I "Raw RS-232"
.RS
TODO
.RE
.PP
.I "Raw SinclairNET"
.RS
TODO
.RE
.PP
.I "Black and white TV"
.RS
This option allows you to choose whether to simulate a colour or black
and white television. This is effective only under the GTK+ and SDL
user interfaces: the others will always simulate a colour TV.
.RE
.PP
.I "PAL-TV use TV2x effect"
.RS
This option allows you to choose whether the PAL TV 2x and higher scalers
also reproduce scanlines in the same way as the TV 2x, 3x and Timex TV
scalers.
.RE
.PP
.I "Confirm actions"
.RS
Specify whether `dangerous' actions (those which could cause data
loss, for example resetting the Spectrum) require confirmation before
occuring.
.RE
.PP
.I "Show statusbar"
.RS
For the GTK+ UI, enables the statusbar beneath the display. For the
SDL UI, enables the status icons showing whether the disk and tape are
being accessed. This option has no effect for the other user
interfaces.
.RE
.PP
.I "Snap joystick prompt"
.RS
If set, Fuse will prompt you which physical joystick or keyboard you want
to connect to the joystick interface enabled in the snapshot unless it
already matches your current configuration.
.RE
.PP
.I "Options, Sound..."
.RS
Display the Sound Options dialog, letting you configure Fuse's sound
output. (With the widget UI, the keys shown in brackets toggle the
options,
.I Enter
confirms any changes, and
.I Esc
aborts). Note that any changed settings only apply to the
currently-running Fuse.
.PP
.I "Sound enabled"
.RS
Specify whether sound output should be enabled at all. When this
option is disabled, Fuse will not make any sound.
.RE
.PP
.I "Loading sound"
.RS
Normally, Fuse emulates tape-loading noise when loading from TAPs or
TZXs in real-time, albeit at a deliberately lower volume than on a
real Spectrum. You can disable this option to eliminate the loading
noise entirely.
.RE
.PP
.I "AY stereo separation"
.RS
By default, the sound output is mono, since this is all you got from
an unmodified Spectrum. But enabling this option gives you so-called
ACB stereo (for sound from the 128's AY-3-8912 sound chip). This
actually works a little better than ACB stereo modifications for the
machine itself, since it uses stereo positioning rather than simply
playing on one channel only.
.RE
.PP
.I "Beeper pseudo-stereo"
.RS
The Spectrum beeper is inherently mono, but enabling this option adds
a simple fake-stereo effect. While the slight echo involved can
sometimes make beeper noise sound worse, in many cases it gives an
acceptable result.
.RE
.PP
.I "Force 8-bit"
.RS
Force the use of 8-bit sound even if 16-bit (the default) is
available. Note that (when the option is enabled) if 8-bit sound isn't
available then there will be no sound at all, so it's best not to use
this option unless you have a specific need for it.
.RE
.RE
.PP
.I "Options, Peripherals..."
.RS
Display the Peripherals Options dialog, letting you configure the
peripherals which Fuse will consider to be attached to the emulated
machines. (With the widget UI, the keys shown in brackets toggle the
options,
.I Enter
confirms any changes, and
.I Esc
aborts). Note that any changed settings only apply to the
currently-running Fuse.
.PP
.I "Kempston joystick"
.RS
If this option is selected, Fuse will emulate a Kempston joystick
interface (probably the most widely supported type on the Spectrum).
Note that this option is basically equivalent to plugging the
interface itself into a Spectrum, not to connecting a joystick; this
affects how the Spectrum responds to a read of input port 31. To use a
Kempston joystick in a game, this option must be enabled, and you must
also select a Kempston joystick the
.I "Options, Joysticks"
menu.
.RE
.PP
.I "Kempston mouse"
.RS
If this option is selected, Fuse will emulate a Kempston mouse interface.
.PP
If you're using Fuse full-screen, your mouse is automatically used as if
attached to the Kempston interface. Otherwise, you'll need to click on the
Spectrum display in order to tell Fuse to grab the pointer (and make it
invisible); to tell Fuse to release it, click the middle button (or wheel) or
press Escape.
.PP
With the framebuffer UI, Fuse prefers to use GPM; if this is not available,
it will fall back to built-in PS/2 mouse support. In this mode, it tries
\fI/dev/input/mice\fR, \fI/dev/mouse\fR then \fI/dev/psaux\fR, stopping when
it successfully opens one. The first of these is preferred since (at least on
Linux, with a 2.6-series kernel) any type of mouse can be used and any
connected mouse may be used.
.PP
.I "Interface I"
.RS
If this option is selected, Fuse will emulate the simple Sinclair
Interface I, and allow microdrive cartriges to be
connected and disconnected via the
.I "Media, Interface I, Microdrive"
menus. It also enables support for the Interface I RS-232 and Sinclair
network interfaces.
.RE
.PP
.I "Interface II"
.RS
If this option is selected, Fuse will emulate a cartridge port as
found on the Interface II. Cartridges can then be inserted and removed
via the
.I "Media, Cartridge, Interface II"
menu. Note that the Pentagon, Scorpion, Interface II, ZXATASP and ZXCF
all use the same hardware mechanism for accessing some of their
extended features, so only one of these should be selected at once or
unpredictable behaviour will occur.
.RE
.PP
.I "Emulate printers"
.RS
If this option is selected, Fuse will emulate a printer. See the
.B "PRINTER EMULATION"
section for more details.
.RE
.PP
.I "Simple 8-bit IDE"
.RS
If this option is selected, Fuse will emulate the simple 8-bit IDE
interface as used by the Spectrum +3e, and allow hard disks to be
connected and disconnected via the
.I "Media, IDE, Simple 8-bit"
menu.
.RE
.PP
.I "ZXATASP interface"
.RS
If this option is selected, Fuse will emulate the ZXATASP interface,
which provides both additional RAM and an IDE interface. See the
.B "ZXATASP AND ZXCF"
section for more details.
.RE
.PP
.I "ZXATASP upload"
.RS
This option controls the state of the ZXATASP upload jumper. See the
.B "ZXATASP AND ZXCF"
section for more details.
.RE
.PP
.I "ZXATASP write protect"
.RS
This option controls the state of the ZXATASP write protect
jumper. See the
.B "ZXATASP AND ZXCF"
section for more details.
.RE
.PP
.I "ZXCF interface"
.RS
If this option is selected, Fuse will emulate the ZXCF interface,
which provides both additional RAM and a CompactFlash interface. See
the
.B "ZXATASP AND ZXCF"
section for more details.
.RE
.PP
.I "ZXCF upload"
.RS
This option controls the state of the ZXCF upload jumper. See the
.B "ZXATASP AND ZXCF"
section for more details.
.RE
.PP
.I "DivIDE interface"
.RS
If this option is selected, Fuse will emulate the DivIDE
interface. See the
.B "DIVIDE"
section for more details.
.RE
.PP
.I "DivIDE write protect"
.RS
This option controls the state of the DivIDE write protection
jumper. See the
.B "DIVIDE"
section for more details.
.RE
.PP
.I "Options, RZX..."
.RS
Display the RZX Options dialog, letting you configure how Fuse's deals
with RZX input recordings. (With the widget UI, the keys shown in
brackets toggle the options,
.I Enter
confirms any changes, and
.I Esc
aborts). Note that any changed settings only apply to the
currently-running Fuse.
.PP
.I "Compress RZX data"
.RS
If this option is selected, and
.I zlib
was available when Fuse was compiled, any RZX files written by Fuse
will be compressed. This is generally a good thing as it makes the
files significantly smaller, and you probably want to turn it off only
if you're debugging the RZX files or there's some other program which
doesn't support compressed RZX files.
.RE
.PP
.I "Competition mode"
.RS
Any input recordings which are started when this option is selected
will be made in `competition mode'. In essence, this means that Fuse
will act just like a real Spectrum would: you can't load snapshots,
pause the emulation in any way, change the speed or anything that you
couldn't do on the real machine. If any of these things are attempted,
or if the emulated Fuse is running more than 5% faster or slower than
normal Spectrum speed, then the recording will immediately be stopped.
.PP
If
.I libgcrypt
was available when Fuse was compiled, then recordings made with
competition mode active will be digitally signed, in theory to
`certify' that it was made with the above restrictions in place.
\fBHowever, this procedure is not secure (and cannot be made so), so
the presence of any signature on an RZX file should not be taken as
providing proof that it was made with competition mode active.\fR
This feature is included in Fuse solely as it was one of the
requirements for Fuse to be used in an on-line tournament.
.RE
.PP
.I "Competition code"
.RS
The numeric code entered here will be written into any RZX files made
in competition mode. This is another feature for on-line tournaments
which can be used to `prove' that the recording was made after a
specific code was released. If you're not playing in such a
tournament, you can safely ignore this option.
.RE
.PP
.I "Always embed snapshot"
.RS
Specify whether a snapshot should be embedded in an RZX file when
recording is started from an existing snapshot.
.RE
.RE
.PP
.I "Options, Joysticks"
.RS
Fuse can emulate many of the common types of joystick which were
available for the Spectrum. The input for these emulated joysticks can
be taken from real joysticks attached to the emulating machine
(configured via the
.I "Options, Joysticks, Joystick 1..."
and
.I "Options, Joysticks, Joystick 2..."
options), or from the
.IR q ,
.IR a ,
.IR o ,
.IR p ,
and
.I Space
keys on the emulating machines keyboard, configured via the
.I "Options, Joysticks, Keyboard..."
option. Note that when using the keyboard to emulate a joystick, the
.IR q ,
.IR a ,
.IR o ,
.IR p ,
and
.I Space
keys will not have their normal effect (to avoid problems with games
which do things like use
.I p
for pause when using a joystick).
.PP
Each of the joysticks (including the `fake' keyboard joystick) can be
configured to emulate any one of the following joystick types:
.RS
.PP
.I None
.RS
No joystick: any input will simply be ignored.
.RE
.PP
.I Cursor
.RS
A cursor joystick, equivalent to pressing
.IR 5 " (left),"
.IR 6 " (down),"
.IR 7 " (up),"
.IR 8 " (right),"
and
.IR 0 " (fire)."
.RE
.PP
.I Kempston
.RS
A Kempston joystick, read from input port 31. Note that the
.I "Options, Peripherals, Kempston interface"
option must also be set for the input to be recognised.
.RE
.PP
.I Sinclair 1
.br
.I Sinclair 2
.RS
The `left' and `right' Sinclair joysticks, equivalent to pressing
.IR 1 " (left),"
.IR 2 " (right),"
.IR 3 " (down),"
.IR 4 " (up),"
and
.IR 5 " (fire),"
or
.IR 6 " (left),"
.IR 7 " (right),"
.IR 8 " (down),"
.IR 9 " (up),"
and
.IR 0 " (fire)"
respectively.
.RE
.PP
.I Timex 1
.br
.I Timex 2
.RS
The `left' and `right' joysticks as attached to the Timex 2068 variant's
built-in joystick interface.
.RE
.RE
.PP
For the real joysticks, it is also possible to configure (although
currently only when using the GTK+ interface) what effect each button
on the joystick will have: this can be
.IR "Joystick Fire" ,
equivalent to presing the emulated joystick's fire button,
.IR "Nothing" ,
meaning to have no effect, or any Spectrum key, meaning that pressing
that button will be equivalent to pressing that Spectrum key.
.RE
.PP
.I "Options, Select ROMs"
.RS
An individual dialog is available for each Spectrum variant emulated
by Fuse which allows selection of the ROM(s) used by that
machine. Simply select the ROM you wish to use, and then reset the
Spectrum for the change to take effect.
.RE
.PP
.I "Options, Filter..."
.RS
Select the graphics filter currently in use. See the
.B "GRAPHICS FILTERS"
section for more details.
.RE
.PP
.I "Options, Save"
.RS
If
.I libxml2
was available when Fuse was compiled, this will cause Fuse's current
options to be written to
.I .fuserc
in your home directory, from which they will be picked up again when
Fuse is restarted. The best way to update this file is by using this
option, but it's a simple XML file and shouldn't be too hard to edit
by hand if you really want to.
.RE
.PP
.I Pause
.br
.I "Machine, Pause"
.RS
Pause or unpause emulation. This option is available only under the
GTK+ UI; to pause the other user interfaces, simply press F1 to bring
up the main menu.
.RE
.PP
.I F5
.br
.I "Machine, Reset"
.RS
Reset the emulated Spectrum. Again, you get a chance to cancel this if
you're using the GTK+ UI.
.RE
.PP
.I F9
.br
.I "Machine, Select..."
.RS
Choose a type of Spectrum to emulate. An brief overview of the
Sinclair, Amstrad and Timex can be found at
.IR "http://www.nvg.ntnu.no/sinclair/computers/zxspectrum/zxspectrum.htm"
while more technical information can be found at
.IR "http://www.worldofspectrum.org/faq/reference/reference.htm" ,
and
.IR "http://www.worldofspectrum.org/faq/reference/tmxreference.htm" .
.PP
.I "Spectrum 16K"
.br
.I "Spectrum 48K"
.RS
The original machines as released by Sinclair in 1982 with 16 or 48K
of RAM respectively.
.RE
.PP
.I "Spectrum 128K"
.RS
The 128K machine as released by Sinclair in 1985 (Spain) or 1986 (UK).
.RE
.PP
.I "Spectrum +2"
.RS
The first machine released by Amstrad, in 1986. From an emulation
point of view, the +2 is virtually identical to the 128K.
.RE
.PP
.I "Spectrum +2A"
.br
.I "Spectrum +3"
.RS
The two machines released by Amstrad in 1988. Technically very similar
to each other, except that the +3 features a 3" disk drive while the
+2A does not.
.RE
.PP
.I "Spectrum +3e"
.RS
A +3 with modified ROMs allowing access to IDE hard disks via the
simple 8-bit interface, as activated from the
.I "Options, Peripherals"
dialog. See
.I "http://www.zxplus3e.plus.com/"
for more details.
.RE
.PP
.I "Timex TC2048"
.br
.I "Timex TC2068"
.RS
The variants of the Spectrum as released by Timex in Portugal.
.RE
.I "Timex TS2068"
.RS
The variant of the Spectrum released by Timex in North America.
.RE
.PP
.I "Pentagon 128K"
.br
.I "Scorpion ZS 256"
.RS
Two Russian clones of the Spectrum. Some details can be found
at
.IR "http://www.worldofspectrum.org/rusfaq/index.html" ,
but possibly the most important thing to note about both these
machines is that they have built in 3.5" disk drives, accessed via the
Betadisk interface and TR-DOS (the Technology Research Disk Operating
System).
.RE
.PP
.I "Spectrum SE"
.RS
A recent variant designed by Andrew Owen and Jarek Adamski, which is
possibly best thought of as a cross between the 128K machine and the
Timex variants, allowing 272K of RAM to be accessed. Some more details
are available at
.IR "http://www.worldofspectrum.org/faq/reference/sereference.htm" .
.RE
.RE
.PP
.I "Machine, Debugger..."
.RS
Start the monitor/debugger. See the
.B "MONITOR/DEBUGGER"
section for more information.
.RE
.PP
.I "Machine, Poke Finder..."
.RS
Start the `poke finder' (available only under the GTK+ UI). See the
.B "POKE FINDER"
section for more information.
.RE
.PP
.I "Machine, Memory Browser..."
.RS
Start the memory browser. It should be fairly obvious what this does;
perhaps the only thing worth noting is that emulation is paused until
you close the window.
.RE
.PP
.I "Machine, NMI"
.RS
Sends a non-maskable interrupt to the emulated Spectrum. Due to a typo
in the standard 48K ROM, this will cause a reset, but modified ROMs are 
available which make use of this feature.
.RE
.PP
.I F7
.br
.I "Media, Tape, Open..."
.RS
Choose a TAP or TZX virtual-tape file to load from. See the
.B "FILE SELECTION"
section below for details on how to choose the file. If
.I "Auto-load media"
is set in the General Options dialog (as it is by default), the tape
will begin loading. Otherwise, you have to start the load in the
emulated machine (with LOAD "" or the 128's Tape Loader option, though
you may need to reset first).
.PP
To
.I guarantee
that TZX files will load properly, you should select the file, make
sure tape-loading traps are disabled in the General Options dialog,
then press
.I F8
(or do
.IR "Media, Tape, Play" ).
That said, most TZXs will work with tape-loading traps enabled (often
quickly loading partway, then loading the rest real-time), so you
might want to try it that way first.
.RE
.PP
.I F8
.br
.I "Media, Tape, Play"
.RS
Start playing the TAP or TZX file, if required. (Choosing the option
(or pressing
.IR F8 )
again pauses playback, and a further press resumes). To explain - if
tape-loading traps have been disabled (in the General Options dialog),
starting the loading process in the emulated machine isn't enough. You
also have to `press play', so to speak :\-), and this is how you do
that. You may also need to `press play' like this in certain other
circumstances, e.g. TZXs containing multi-load games may have a
stop-the-tape request (which Fuse obeys).
.RE
.PP
.I "Media, Tape, Browse"
.RS
Browse through the current tape. A brief display of each of the data
blocks on the current tape will appear, from which you can select
which block Fuse will play next. With the GTK+ UI, emulation will
continue while the browser is displayed; double-clicking on a block
will select it. In the other UIs, emulation is paused and you can use
the cursor keys and press
.I Enter
to select it. If you decide you don't want to change block, just press
.IR Escape .
.RE
.PP
.I "Media, Tape, Rewind"
.RS
Rewind the current virtual tape, so it can be read again from the
beginning.
.RE
.PP
.I "Media, Tape, Clear"
.RS
Clear the current virtual tape. This is particularly useful when you
want a `clean slate' to add newly-saved files to, before doing
.I "Media, Tape, Write..."
(or
.IR F6 ).
.RE
.PP
.I F6
.br
.I "Media, Tape, Write..."
.RS
Write the current virtual-tape contents to a TZX file. You will be
prompted for a filename. The virtual-tape contents are the contents of
the previously-loaded tape (if any has been loaded since you last did
a
.IR "Media, Tape, Clear" ),
followed by anything you've saved from the emulated machine since.
These newly-saved files are
.I not
written to any tape file until you choose this option!
.RE
.PP
.I "Media, Interface I"
.RS
Virtual microdrive images are accessible only when the Interface I is
active from the
.I "Options, Peripherals"
menu. Note that any changes to the microdrive image will not be
written to the file on disk until the appropriate `sync' or `eject'
option is used.
.RE
.PP
.I "Media, Interface I, Microdrive 1, Insert New"
.RS
Insert a new (unformatted) microdrive cartridge into emulated
Microdrive 1.
.RE
.PP
.I "Media, Interface I, Microdrive 1, Insert..."
.RS
Insert an existing microdrive cartridge image into emulated Microdrive
1. You will be prompted for a filename.
.RE
.PP
.I "Media, Interface I, Microdrive 1, Sync"
.RS
Synchronise any changes to the microdrive image in Microdrive 1 with
the file on sync. You will be prompted for a filename if one has not
supplied already for this image.
.RE
.PP
.I "Media, Interface I, Microdrive 1, Eject"
.RS
Eject the microdrive image in Microdrive 1. If the image has been
modified, you will be asked as to whether you want any changes saved.
.RE
.PP
.I "Media, Interface I, Microdrive 1, Write protect, Set"
.RS
Set the write protect tab for the image in Microdrive 1.
.RE
.PP
.I "Media, Interface I, Microdrive 1, Write protect, Remove"
.RS
Remove the write protect tab for the image in Microdrive 1.
.RE
.PP
.I "Media, Interface I, Microdrive 2, ..."
.br
.I "Media, Interface I, Microdrive 3, ..."
.br
.I "Media, Interface I, Microdrive 4, ..."
.br
.I "Media, Interface I, Microdrive 5, ..."
.br
.I "Media, Interface I, Microdrive 6, ..."
.br
.I "Media, Interface I, Microdrive 7, ..."
.br
.I "Media, Interface I, Microdrive 8, ..."
.RS
Equivalent options for the other emulated Microdrives.
.RE
.PP
.I "Media, Interface I, RS232, Plug RxD"
.RS
TODO
.RE
.I "Media, Interface I, RS232, Unplug RxD"
.RS
TODO
.RE
.I "Media, Interface I, RS232, Plug TxD"
.RS
TODO
.RE
.I "Media, Interface I, RS232, Unlug TxD"
.RS
TODO
.RE
.PP
.I "Media, Interface I, Sinclair NET, Plug in"
.RS
TODO
.RE
.PP
.I "Media, Interface I, Sinclair NET, Unplug"
.RS
TODO
.RE
.PP
.I "Media, Disk"
.RS
Virtual disk images are accessible only when emulating a +3, +3e,
Pentagon or Scorpion. (See
.B "THE .DSK FORMAT"
and
.B "TR-DOS DISK FORMATS"
sections below for notes on the file formats supported).
.PP
Once again, any changes made to a disk image will not affect the file
which was `inserted' into the drive. If you do want to keep any
changes, use the appropriate `eject and write' option before exiting
Fuse.
.RE
.PP
.I "Media, Disk, +3, Drive A:, Insert..."
.RS
Select a disk-image file to read/write in the +3's emulated drive
A:.
.RE
.PP
.I "Media, Disk, +3, Drive A:, Eject"
.RS
Deselect the disk image currently in the +3's emulated drive A: - or
from the emulated machine's perspective, eject it. Note that any
changes made to the image will not be saved.
.RE
.PP
.I "Media, Disk, +3, Drive A:, Eject and write..."
.RS
Deselect the disk image currently in the +3's drive A: and write the
current state of the disk to a file. The GTK+ UI lets you select a
filename, while the others will write the image to
.RI ` drivea.dsk '.
.RE
.PP
.I "Media, Disk, +3, Drive B:, Insert..."
.RS
As above, but for the +3's drive B:. Fuse emulates drive B: as a
second 3\" drive.
.RE
.PP
.I "Media, Disk, +3, Drive B:, Eject"
.RS
As above, but for drive B:.
.RE
.PP
.I "Media, Disk, +3, Drive B:, Eject and write"
.RS
As above, but for drive B:. The widget-based UIs will save to
.RI ` driveb.dsk '.
.RE
.PP
.I "Media, Disk, TR-DOS, Drive A:, Insert..."
.br
.I "Media, Disk, TR-DOS, Drive A:, Eject"
.br
.I "Media, Disk, TR-DOS, Drive A:, Eject and write..."
.br
.I "Media, Disk, TR-DOS, Drive B:, Insert..."
.br
.I "Media, Disk, TR-DOS, Drive B:, Eject"
.br
.I "Media, Disk, TR-DOS, Drive B:, Eject and write..."
.br
.RS
As above, but for the emulated TR-DOS drives. The widget-based UIs
will save to
.RI ` drivea.trd '
and
.RI ` driveb.trd '
respectively.
.RE
.PP
.I "Media, Cartridge, Timex Dock, Insert..."
.RS
Insert a cartridge into the Timex 2068 dock. This will cause the
emulated machine to be changed to the TC2068 (if it wasn't already
a 2068 variant) and reset.
.RE
.PP
.I "Media, Cartridge, Timex Dock, Eject"
.RS
Remove the cartridge from the Timex 2068 dock. This will cause the
emulated machine to be reset.
.RE
.PP
.I "Media, Cartridge, Interface II, Insert..."
.RS
Insert a cartridge into the Interface II cartridge slot. This will
cause the emulated machine to be reset and the cartridge loaded.
.RE
.PP
.I "Media, Cartridge, Interface II, Eject..."
.RS
Remove the cartridge from the Interface II cartridge slot. This will
cause the emulated machine to be reset.
.RE
.PP
.I "Media, IDE, Simple 8-bit, Master, Insert..."
.RS
Connect an IDE hard disk to the simple 8-bit interface's master channel.
.RE
.PP
.I "Media, IDE, Simple 8-bit, Master, Commit"
.RS
Cause any writes which have been done to virtual hard disk attached to
the simple 8-bit interface's master channel to be committed to the
real disk, such that they survive the virtual disk being ejected.
.RE
.PP
.I "Media, IDE, Simple 8-bit, Master, Eject"
.RS
Eject the virtual hard disk from the simple 8-bit interface's master
channel. Note that any writes to the virtual hard disk will be lost
unless the
.I "Media, IDE, Simple 8-bit, Master, Commit"
option is used before the disk is ejected.
.RE
.PP
.I "Media, IDE, Simple 8-bit, Slave, Insert..."
.br
.I "Media, IDE, Simple 8-bit, Slave, Commit"
.br
.I "Media, IDE, Simple 8-bit, Slave, Eject"
.RS
The same as the
.I "Media, IDE, Simple 8-bit, Master"
entries above, but for the simple 8-bit interface's slave channel.
.RE
.PP
.I "Media, IDE, ZXATASP, Master, Insert..."
.br
.I "Media, IDE, ZXATASP, Master, Commit"
.br
.I "Media, IDE, ZXATASP, Master, Eject"
.br
.I "Media, IDE, ZXATASP, Slave, Insert..."
.br
.I "Media, IDE, ZXATASP, Slave, Commit"
.br
.I "Media, IDE, ZXATASP, Slave, Eject"
.RS
The same as the
.I "Media, IDE, Simple 8-bit, Master"
entries above, but for the two channels of the ZXATASP interface.
.RE
.PP
.I "Media, IDE, ZXCF CompactFlash, Insert..."
.br
.I "Media, IDE, ZXCF CompactFlash, Commit"
.br
.I "Media, IDE, ZXCF CompactFlash, Eject"
.RS
The same as the
.I "Media, IDE, Simple 8-bit, Master"
entries above, but for the ZXCF interface's CompactFlash slot.
.RE
.PP
.I "Media, IDE, DivIDE, Master, Insert..."
.br
.I "Media, IDE, DivIDE, Master, Commit"
.br
.I "Media, IDE, DivIDE, Eject"
.br
.I "Media, IDE, DivIDE, Slave, Insert..."
.br
.I "Media, IDE, DivIDE, Slave, Commit"
.br
.I "Media, IDE, DivIDE, Eject"
.RS
The same as the
.I "Media, IDE, Simple 8-bit"
entries above, but for the two channels of the DivIDE interface.
.RE
.PP
.I "Help, Keyboard picture..."
.RS
Display a diagram showing the Spectrum keyboard, and the various
keywords that can be generated with each key from (48K) BASIC. Under
the GTK+ UI, this will appear in a separate window and emulation
continues. With the other UIs, the picture remains onscreen (and the
emulator paused) until you press
.I Esc
or
.IR Enter .
.RE
.PP
.\"
.\"------------------------------------------------------------------
.\"
.SH "KEY MAPPINGS"
When emulating the Spectrum, keys
.I F1
to
.I F10
are used as shortcuts for various menu items, as described above. The
alphanumeric keys (along with
.I Enter
and
.IR Space )
are mapped as-is to the Spectrum keys. The other key mappings are:
.TP
.I Shift
emulated as Caps Shift
.TP
.IR Control ", " Alt ", and " Meta
emulated as Symbol Shift (most other modifiers are also mapped to
this)
.TP
.I Backspace
emulated as Caps-0 (Delete)
.TP
.I Esc
emulated as Caps-1 (Edit)
.TP
.I Caps Lock
emulated as Caps-2
.TP
.I Cursor keys
emulated as Caps-5/6/7/8 (as appropriate)
.TP
.I Tab
emulated as Caps Shift-Symbol Shift (Extended Mode)
.PP
Some further punctuation keys are supported, if they exist on your
keyboard -
.RI ` , ',
.RI ` . ',
.RI ` / ',
.RI ` ; ',
.RI ` \(aq ',
.RI ` # ',
.RI ` \- ',
and
.RI ` = '.
These are mapped to the appropriate symbol-shifted keys on the
Spectrum.
.PP
A list of keys applicable when using the file selection dialogs is
given in the
.B "FILE SELECTION"
section below.
.\"
.\"------------------------------------------------------------------
.\"
.SH "DISPLAY SIZE"
Some of Fuse's UIs allow resizing of the emulated Spectrum's display.
For the window-based ones (GTK+ and Xlib), you can resize the window
by, well, resizing it. :\-) Exactly how this works depends on your
window manager; you may have to make the window over twice the width
and height of the original size before it actually scales up. Fuse
attempts to keep the window `square', but with some window managers
this can mean the window will never resize at all. If you experience
this problem, the
.RI ` \-\-no\-aspect\-hint '
option may help.
.PP
If you're using the SDL UI under X11, the window will automatically
resize to be the correct size for the graphics filter selected.
.\"
.\"------------------------------------------------------------------
.\"
.SH "GRAPHICS FILTERS"
Fuse has the ability to apply essentially arbitrary filters between
building its image of the Spectrum's screen, and displaying it on the
emulating machine's monitor. These filters can be used to do various
forms of smoothing, emulation of TV scanlines and various other
possibilities. Support for graphics filters varies between the
different user interfaces, but there are two general classes: the GTK+
and SDL user interfaces (and the saving of .png screenshots) support
`interpolating' filters which use a palette larger than the Spectrum's
16 colours, while the Xlib and SVGAlib user interfaces support only
`non-interpolating' filters. The framebuffer user interface currently
does not support filters at all.
.PP
A further complication arises due to the fact that the Timex machines
have their high-resolution video mode with twice the horizontal
resolution. To deal with this, Fuse treats these machines as having a
`normal' display size which is twice the size of a normal Spectrum's
screen, leading to a different set of filters being available for
these machines. Note that any of the double or triple-sizing filters
are available for Timex machines only when using the SDL user
interface.
.PP
The available filters, along with their short name used to select them
from the command line, are:
.PP
.IR "Timex half (smoothed) " ( half )
.br
.IR "Timex half (skipping) " ( halfskip )
.RS
Two Timex-machine specific filters which scale the screen down to half
normal (Timex) size; that is, the same size as a normal Spectrum
screen. The difference between these two filters is in how they handle
the high-resolution mode: the `smoothed' version is an interpolating
filter which averages pairs of adjacent pixels, while the `skipping'
version is a non-interpolating filter which simply drops every other
pixel.
.RE
.PP
.IR "Normal " ( normal )
.RS
The simplest filter: just display one pixel for every pixel on the
Spectrum's screen.
.RE
.PP
.IR "Double size " ( 2x )
.RS
Scale the displayed screen up to double size.
.RE
.PP
.IR "Triple size " ( 3x )
.RS
Scale the displayed screen up to triple size. Available only with the
GTK+ and SDL user interfaces or when saving screenshots of non-Timex
machines.
.RE
.PP
.IR "2xSaI " ( 2xsai )
.br
.IR "Super 2xSaI " ( super2xsai )
.br
.IR "SuperEagle " ( supereagle )
.RS
Three interpolating filters which apply successively more
smoothing. All three double the size of the displayed screen.
.RE
.PP
.IR "AdvMAME2x " ( advmame2x )
.RS
A double-sizing, non-interpolating filter which attempts to smooth
diagonal lines.
.RE
.PP
.IR "AdvMAME3x " ( advmame3x )
.RS
Very similar to
.IR AdvMAME2x ,
except that it triples the size of the displayed screen. Available
only with the GTK+ and SDL user interfaces or when saving screenshots
of non-Timex machines.
.RE
.PP
.IR "TV 2x " ( tv2x )
.br
.IR "TV 3x " ( tv3x )
.br
.IR "Timex TV " ( timextv )
.RS
Three filters which attempt to emulate the effect of television
scanlines. The first is a double-sizing filter for non-Timex
machines, the second is a similar triple-sizing filter, while the last
is a single-sizing filter for Timex machines (note that this means TV 2X
and Timex TV produce the same size output).
.RE
.PP
.IR "PAL TV" ( paltv )
.br
.IR "PAL TV 2x " ( paltv2x )
.br
.IR "PAL TV 3x " ( paltv3x )
.RS
Three filters which attempt to emulate the effect of the PAL TV system
which layers a lower-resolution colour image over the top of a
higher-resolution black-and-white image. The filters can also optionally
add scanlines like the other TV series scalers.
.RE
.PP
.IR "Dot matrix " ( dotmatrix )
.RS
A double-sizing filter which emulates the effect of a dot-matrix
display.
.RE
.PP
.IR "Timex 1.5x " ( timex15x )
.RS
An interpolating Timex-specific filter which scales the Timex screen
up to 1.5x its usual size (which is therefore 3x the size of a
`normal' Spectrum screen). Available only for the GTK+ and SDL user
interfaces or when saving screenshots.
.\"
.\"------------------------------------------------------------------
.\"
.SH "THE EMULATED SPECTRUM"
The emulated Spectrum is, by default, an unmodified 48K Spectrum with
a tape player and ZX Printer attached. Oh, and apparently some magical
snapshot load/save machine which is probably best glossed over for the
sake of the analogy. :\-)
.PP
To emulate different kinds of Spectrum, select the
.I "Machine, Select..."
menu option, or press
.IR F9 .
.PP
The Spectrum emulation is paused when any dialogs appear. In the
widget UI, it's also paused when menus or the keyboard picture are
displayed.
.\"
.\"------------------------------------------------------------------
.\"
.SH "PRINTER EMULATION"
The various models of Spectrum supported a range of ways to connect
printers, three of which are supported by Fuse. Different printers are
made available for the different models:
.TP
.IR 16 ", " 48 ", " TC2048 ", " TC2068 ", " TS2068
ZX Printer
.TP
.IR 128 / +2 / Pentagon
Serial printer (text-only)
.TP
.IR +2A ", " +3
Parallel printer (text-only)
.PP
Any printout is appended to one (or both) of two files, depending on
the printer - these default to
.I printout.txt
for text output, and
.I printout.pbm
for graphics (PBM images are supported by most image viewers and
converters). These names can be changed with the
.I \-\-textfile
and
.I \-\-graphicsfile
options from the command line or configuration file. While the ZX
Printer can
.I only
output graphically, simulated text output is generated at the same
time using a crude sort of OCR based on the current character set (a
bit like using SCREEN$). There is currently no support for graphics
when using the serial/parallel output, though any escape codes used
will be `printed' faithfully. (!)
.PP
By the way, it's not a good idea to modify the
.I printout.pbm
file outside of Fuse if you want to continue appending to it. The
header needs to have a certain layout for Fuse to be able to continue
appending to it correctly, and the file will be overwritten if it
can't be appended to.
.\"
.\"------------------------------------------------------------------
.\"
.SH "ZXATASP AND ZXCF"
The ZXATASP and ZXCF interfaces are two peripherals designed by Sami
Vehmaa which significantly extend the capabilities of the
Spectrum. More details on both are available from Sami's homepage,
.IR "http://user.tninet.se/~vjz762w/" ,
but a brief overview is given here.
.PP
The real ZXATASP comes with either 128K or 512K of RAM and the ability
to connect an IDE hard disks and a CompactFlash card, while the ZXCF
comes with 128K, 512K or 1024K of RAM and the ability to connect a
CompactFlash card. From an emulation point of view, the two interfaces
are actually very similar as a CompactFlash card is logically just an
IDE hard disk. Currently, Fuse's emulation is fixed at having 512K of
RAM in the ZXATASP and 1024K in the ZXCF.
.PP
To activate the ZXATASP, simply select the
.I "ZXATASP interface"
option from the
.I "Options, Peripherals..."
dialog. The state of the upload and write protect jumpers is then
controlled by the
.I "ZXATASP upload"
and
.I "ZXATASP write protect"
options. Similarly, the ZXCF is controlled by the
.I "ZXCF interface"
and
.I "ZXCF upload"
options (the ZXCF write protect is software controlled).
.PP
If you're using either the ZXATASP or ZXCF, you almost certainly want
to investigate ResiDOS, the operating system designed for use with the
ZXATASP and ZXCF. ResiDOS provides facilities for using the extra RAM,
accessing the mass storage devices and a task manager allowing
virtually instant switching between programs on the Spectrum. See
.I "http://www.zxplus3e.plus.com/residos/index.html"
for more details.
.\"
.\"------------------------------------------------------------------
.\"
.SH "DIVIDE"
The DivIDE is another IDE interface for the Spectrum, of which full
details can be found at 
.IR "http://baze.au.com/divide/" .
The interface can be activated via the
.I "DivIDE interface"
option from the
.I "Options, Peripherals..."
dialog, and the state of its write protect jumper controlled via the
.IR "DivIDE write protect option" .
If you're going to be using the DivIDE, you'll probably want one of
the firmwares available from the DivIDE homepage.
.\"
.\"------------------------------------------------------------------
.\"
.SH "FILE SELECTION"
The way you select a file (whether snapshot or tape file) depends on
which UI you're using. So firstly, here's how to use the GTK+ file
selector.
.PP
The selector shows the directories and files in the current directory
in two separate subwindows. If either list is too big to fit in the
window, you can use the scrollbar to see the rest (by dragging the
slider, for example), or you can use
.I Shift-Tab
(to move the keyboard focus to a subwindow) and use the cursor keys.
To change directory, double-click it.
.PP
To choose a file to load you can either double-click it, or click it
then click
.IR Ok .
Or click
.I Cancel
to abort.
.PP
If you're using the keyboard, probably the easiest way to use the
selector is to just ignore it and type in the name. This isn't as
irksome as it sounds, since the filename input box has filename
completion - type part of a directory or file name, then press
.IR Tab .
It should complete it. If it was a directory, it moves to that
directory; if the completion was ambiguous, it completes as much as
possible, and narrows the filenames shown to those which match. You
should press
.I Enter
when you've finished typing the filename, or
.I Esc
to abort.
.PP
Now, if you're using the widget UI - the one using the Spectrum font -
the selector works a bit differently. The files and directories are
all listed in a single two-column-wide window (the directories are
shown at the top, ending in `/') - the names may be truncated onscreen
if they're too long to fit.
.PP
To move the cursor, you can either use the cursor keys, or the
Spectrum equivalents
.\" too many to portably risk using IR...
\fI5\fR/\fI6\fR/\fI7\fR/\fI8\fR, or (similarly)
\fIh\fR/\fIj\fR/\fIk\fR/\fIl\fR. For faster movement, the
.IR "Page Up" ,
.IR "Page Down" ,
.IR Home ,
and
.I End
keys are supported and do what you'd expect. To select a file or
directory, press
.IR Enter .
To abort, press
.IR Esc .
.PP
With both selectors, do bear in mind that
.I all
files are shown, whether Fuse would be able to load them or not.
.\"
.\"------------------------------------------------------------------
.\"
.SH MONITOR/DEBUGGER
.PP
Firstly, note that the vast majority of this section applies only if
you're using the GTK+ user interface; if you're using one of the
widget user interfaces, you'll get a very basic monitor which shows
the current values of the registers and allows you to single step
through execution or continue.
.PP
If you are using the GTK+ user interface, Fuse features a moderately
powerful, completely transparent monitor/debugger, which can be
activated via the
.I "Machine, Debugger ..."
menu option. A debugger window will appear, showing the current state
of the emulated machine: the top-left `pane' shows the current state
of the Z80 and the last bytes written to any emulated peripherals. The
bottom-left pane lists any active breakpoints. Moving right, the next
pane shows where the Spectrum's 64K memory map (the
.RI ` W? '
and
.RI ` C? '
indicate whether each 8K chunk is writable or contended respectively),
and the next a disassembly, which by default starts at the current
program counter, although this can be modified either by the
`disassemble' command (see below) or by dragging the scrollbar next to
it. The next pane shows the current stack, and the final pane any
`events' which are due to occur and could affect emulation. Any of
these panes can be removed by use of the
.I View
menu. Below the displays are an entry box for debugger commands, and
five buttons for controlling the debugger:
.PP
.I Evaluate
.RS
Evaluate the command currently in the entry box.
.RE
.PP
.I "Single Step"
.RS
Run precisely one Z80 opcode and then stop emulation again.
.RE
.PP
.I Continue
.RS
Restart emulation, but leave the debugger window open. Note that the
debugger window will not be updated while emulation is running.
.RE
.PP
.I Break
.RS
Stop emulation and return to the debugger.
.RE
.PP
.I Close
.RS
Close the debugger window and restart emulation.
.RE
.PP
Double-clicking on an entry in the stack pane will cause emulation to
run until the program counter reaches the value stored at that
address, while double-clicking on an entry in the `events' pane will
cause emulation to run until that time is reached.
.PP
The main power of the debugger is via the commands entered into the
entry box, which are similar in nature (but definitely not identical
to or as powerful as) to those in
.IR gdb (1).
In general, the debugger is case-insensitive, and numbers will be
interpreted as decimal, unless prefixed by either
.RI ` 0x '
or
.RI ` $ '
when they will be interpreted as hex. Each command can be abbreviated
to the portion not in curly braces.
.PP
ba{se}
.I number
.RS
Change the debugger window to displaying output in base
.IR number .
Available values are 10 (decimal) or 16 (hex).
.RE
.PP
br{eakpoint}
.RI [ address "] [" condition ]
.RS
Set a breakpoint to stop emulation and return to the debugger whenever
an opcode is executed at
.I address
and
.I condition
evaluates true. If
.I address
is omitted, it defaults to the current value of PC.
.RE
.PP
br{eakpoint} p{ort} (r{ead}|w{rite})
.IR "port " [ condition ]
.RS
Set a breakpoint to trigger whenever IO port
.I port
is read from or written to and
.I condition
evaluates true.
.RE
.PP
br{eakpoint} (r{ead}|w{rite})
.RI [ address "] [" condition ]
.RS
Set a breakpoint to trigger whenever memory location
.I address
is read from (other than via an opcode fetch) or written to and
.I condition
evaluates true.
.I Address
again defaults to the current value of PC if omitted.
.RE
.PP
br{eakpoint} ti{me}
.IR "time " [ condition ]
.RS
Set a breakpoint to occur
.I time
tstates after the start of the current frame, assuming
.I condition
evaluates true (if one is given).
.RE
.PP
cl{ear}
.RI [ address ]
.RS
Remove all breakpoints at 
.I address
or the current value of PC if
.I address
is omitted. Port read/write breakpoints are unaffected.
.RE
.PP
cond{ition}
.IR "id " [ condition ]
.RS
Set breakpoint
.I id
to trigger only when
.I condition
is true, or unconditionally if
.I condition
is omitted.
.RE
.PP
co{ntinue}
.RS
Equivalent to the
.I Continue
button.
.RE
.PP
del{ete}
.RI [ id ]
.RS
Remove breakpoint
.IR id ,
or all breakpoints if
.I id
is omitted.
.RE
.PP
di{sassemble}
.I address
.RS
Set the centre panel disassembly to begin at
.IR address .
.RE
.PP
fi{nish}
.RS
Exit from the current CALL or equivalent. This isn't infallible: it
works by setting a temporary breakpoint at the current contents of the
stack pointer, so will not function correctly if the code returns to
some other point or plays with its stack in other ways. Also, setting
this breakpoint doesn't disable other breakpoints, which may trigger
before this one. In that case, the temporary breakpoint remains, and
the `continue' command can be used to return to it.
.RE
.PP
i{gnore}
.I id count
.RS
Do not trigger the next
.I count
times that breakpoint
.I id
would have triggered.
.RE
.PP
n{ext}
.RS
Step to the opcode following the current one. As with the `finish'
command, this works by setting a temporary breakpoint at the next
opcode, so is not infalliable.
.RE
.PP
o{ut}
.I port value
.RS
Write
.I value
to IO port
.IR port .
.RE
.PP
se{t}
.I address value
.RS
Poke
.I value
into memory at
.IR address .
.RE
.PP
se{t}
.I register value
.RS
Set the value of the Z80 register
.I register
to
.IR value .
.RE
.PP
s{tep}
.RS
Equivalent to the
.I "Single Step"
button.
.RE
.PP
t{breakpoint}
.RI [ options ]
.RS
This is the same as the `breakpoint' command in its various forms,
except that that breakpoint is temporary: it will trigger once and
once only, and then be removed.
.RE
.PP
Addresses can be specified in one of two forms: either an absolute
addresses, specifed by an integer in the range 0x0000 to 0xFFFF or as
a
.RI ` page : offset '
combination, which refers to a location
.I offset
bytes into into memory bank
.IR page ,
independent of where that bank is currently paged into memory. RAM
pages are indicated simply by an integer, while ROMs are prefixed by
.RI ` R '
(eg offset 0x1234 in ROM 1 is specified as
.RI ` R1:0x1234 "')."
Pages selected via the /ROMCS line are prefixed with
.RI ` C "',"
while the Timex Dock and Exrom use prefixes
.RI ` D '
and
.RI ` X '
respectively. The 48K machines are treated as having a permanent
mapping of page 5 at 0x4000, page 2 at 0x8000 and page 0 at 0xC000;
the 16K Spectrum is treated as having page 5 at 0x4000 and no page at
0x8000 and 0xC000.
.PP
Anywhere the debugger is expecting a numeric value, except where it
expects a breakpoint id, you can instead use a numeric expression,
which uses a restricted version of C's syntax; exactly the same syntax
is used for conditional breakpoints, with `0' being false and any
other value being true. In numeric expressions, you can use integer
constants (all calculations is done in integers), register names
(which simply evaluate to the value of the register), parentheses, the
standard four numeric operations (`+', `\-', `*' and `/'), the
(non-)equality operators `==' and `!=', the comparision operators `>',
`<', `>=' and `<=', bitwise and (`&'), or (`|') and exclusive or (`^')
and logical and (`&&') and or (`||').
.\"
.\"------------------------------------------------------------------
.\"
.SH THE POKE FINDER
.PP
The `poke finder', available only under the GTK+ UI, is a tool which
is designed to make the task of finding (infinite lives etc) pokes for
games a bit easier: it is similar to the `Lifeguard' utility which was
available for use with the Multiface. It works by maintaining a list
of locations in which the current number of lives (etc) may be stored,
and having the ability to remove from that list any locations which
don't contain a specified value.
.PP
The poke finder dialog contains an entry box for specifying the value
to be searched for, a count of the current number of possible
locations and, if there are less than 20 possible locations, a list of
the possible locations (in `page:offset' format). The five buttons
act as follows:
.PP
.I Incremented
.RS
Remove from the list of possible locations all addresses which have
not been incremented since the last search.
.RE
.I Decremented
.RS
Remove from the list of possible locations all addresses which have
not been decremented since the last search.
.RE
.PP
.I Search
.RS
Remove from the list of possible locations all addresses which do not
contain the value specified in the `Search for' field.
.RE
.PP
.I Reset
.RS
Reset the poke finder so that all locations are considered possible.
.RE
.PP
.I Close
.RS
Close the dialog. Note that this does not reset the current state of
the poke finder.
.RE
.PP
Double-clicking on an entry in the list of possible locations will
cause a breakpoint to be set to trigger whenever that location is
written to.
.PP
An example of how to use this may make things a bit clearer. We'll use
the 128K version of Gryzor. Load the game, define keys to suit and
start playing. Immediately pause the game and bring up the poke finder
dialog. We note that we currently have 6 lives, so enter `6' into the
`Search for' field and click `Search'. This reduces the number of
possible locations to around 931 (you may get a slightly different
number depending on exactly when you paused the game). Play along a
bit and then (deliberately) lose a life. Pause the game again. As we
now have 5 lives, replace the `6' in the 'Search for' field with a `5'
and click `Search' again. This then reduces the list of possible
locations to just one: page 2, offset 0x00BC. This is the only
location in memory which stored `6' when we had 6 lives and `5' when
we had 5 lives, so its pretty likely that this is where the lives
count is stored. Double-clicking on the `2:0x00BC' entry in the dialog
will set the appropriate breakpoint (you may wish to open the debugger
at this point to confirm this). Play along a bit more. When you next
lose a life, emulation is stopped with PC at 0x91CD. Scrolling up a
few addresses in the debugger's disassembly pane shows a value was
loaded from 0x80BC (our hypothetical lives counter), decremented and
then stored again to 0x80BC, which looks very much like the code to
reduce the number of lives. We can now use the debugger to replace the
decrement with a NOP (`set 0x91c9 0'), and playing the game some more
after this reveals that this has worked and we now have infinite
lives.
.\"
.\"------------------------------------------------------------------
.\"
.SH THE .DSK FORMAT
.PP
In general, disk images for the +3 Spectrum are thought of as being in
DSK format. However, this is actually an slight oversimplification;
there in in fact
.I two
similar, but not identical, DSK formats. (The difference can be seen
by doing `head \-1
.IR dskfile ':
one format will start `MV \- CPCEMU' and the other will start
`EXTENDED').
.PP
The `lib765' library used by Fuse to emulate the +3's FDC supports the
`CPCEMU' format, but not the extended format. If the `libdsk' library
was also found while compiling Fuse, this is used to provide support
for the extended format, as well as for other goodies such as
compressed disk images.
.\"
.\"------------------------------------------------------------------
.\"
.SH TR-DOS DISK FORMATS
.PP
Fuse supports .SCL and .TRD images in its Pentagon and Scorpion
emulation; truncated .TRD files need to be expanded with another
utility before use with Fuse.
.\"
.\"------------------------------------------------------------------
.\"
.SH COMPRESSED FILES
.PP
Assuming the appropriate libraries were available when
.IR libspectrum (3)
was compiled, snapshots, tape images, dock cartridges and input
recording files can be read from files compressed with
.IR bzip2 (3)
or
.IR gzip (3)
just as if they were uncompressed.
.I libdsk
provides an equivalent functionality for +3 disk images if available,
but there is currently no support for reading compressed TR-DOS disk
images.
.\"
.\"------------------------------------------------------------------
.\"
.SH BUGS
Selecting a startup filter doesn't work properly with user interfaces
other than SDL.
.PP
Attempting to replay an RZX file without an embedded snapshot from the
command-line doesn't work if you do `./fuse
.IR "rzxfile snapshot" '.
`./fuse
.IR "snapshot rzxfile" '
does work though, so use that instead.
.PP
Changing virtual consoles when using SVGAlib for joystick support
causes Fuse to exit. If this is a problem, compile Fuse with the
.RI ` \-\-disable\-ui\-joystick '
option.
.PP
The poke finder can't search outside `normal' RAM.
.PP
Using the 
.I "Options, Joysticks, Joystick 1..."
or
.I "Options, Joysticks, Joystick 2..."
options under GTK+ 2.x produces a large number of GTK+ critical
warnings. This is a GTK+ bug (#144427), which is fixed in GTK+ 2.4.4.
.PP
The libao file output devices not work properly with the GTK+ UI.
No error reporting, but the created file does not contain any sound data.
If you use a "weak" machine alsa09 make a lot of click and pop with
.RI ' "ALSA: underrun, at least 0ms." '
error messages.
.\"
.\"------------------------------------------------------------------
.\"
.SH FILES
.I "~/.fuserc"
.\"
.\"------------------------------------------------------------------
.\"
.SH SEE ALSO
.IR bzip2 "(3),"
.IR fuse\-utils "(1),"
.IR gzip "(3),"
.IR libspectrum "(3),"
.IR ogg123 "(1),"
.IR xspect "(1),"
.IR xzx "(1)"
.PP
The comp.sys.sinclair Spectrum FAQ, at
.br
.IR "http://www.worldofspectrum.org/faq/index.html" .
.\"
.\"------------------------------------------------------------------
.\"
.\" `AUTHOR' here is deliberate; avoiding the plural IMHO makes it
.\" clear that Phil is the main author.
.\"
.SH AUTHOR
Philip Kendall (philip\-fuse@shadowmagic.org.uk).
.PP
Matan Ziv-Av wrote the svgalib and framebuffer UIs, the glib
replacement code, and did some work on the OSS-specific sound code and
the original widget UI code.
.PP
Russell Marks wrote the sound emulation and OSS-specific sound code,
the joystick emulation, some of the printer code, and the original
version of this man page.
.PP
John Elliott's lib765 library emulates the +3's disk controller chip,
providing Fuse's +3 disk support, and his libdsk library provides
support for more disk image formats.
.PP
Ian Collier wrote the ZX Printer emulation (for xz80).
.PP
Darren Salt wrote the original versions of the code for +3 emulation,
SLT support, MITSHM support (for the Xlib UI), TZX raw data blocks,
RZX embedded snapshots and compression, the Kempston mouse emulation
and made many improvements to the widget code.
.PP
Alexander Yurchenko wrote the OpenBSD/Solaris-specific sound code.
.PP
Fredrick Meunier wrote the TC2048, TS2068, Pentagon and Spectrum SE
support, the CoreAudio sound code, as well as maintaining the OS X
port and importing the graphics filter code.
.PP
Ludvig Strigeus and The ScummVM project wrote the original graphics
filter code.
.PP
Dmitry Sanarin wrote the original TR-DOS emulation (for Glukalka).
.PP
Witold Filipczyk wrote the TC2068 support.
.PP
Matthew Westcott wrote the AY logging code and the DivIDE emulation.
.PP
Marek Januszewski wrote various bits of code to make Fuse work under
Win32, including the DirectDraw user interface.
.PP
Stuart Brady wrote the Scorpion emulation and the HP-UX sound code.
.PP
Garry Lancaster wrote the 8-bit IDE, ZXATASP and ZXCF interface
emulations.
.PP
Gergely Szasz wrote the Interface I and microdrive emulation, the PAL
TV scalers, the TV 3x scaler, the movie logging code, the libao sound
code, and made many improvements to the widget code.