-
-
-This currently does not work together with GEMDOS harddisc emulation!
-
-x=0 for 512K, x=1,x=2 or x=4 for 1,2 or 4 MB
Command line options
+ +Usage:
++ hatari [options] [disk image name] ++ +
Hatari command line options are split into several categories:
+ + + + +General options
+| + | +−h, −−help | +
| + | +Print command line options and terminate + | +
| + | +−v, −−version | +
| + | +Print version information and terminate + | +
| + | +−−confirm-quit <bool> | +
| + | +Whether Hatari confirms quitting + | +
| + | +−c, −−configfile +<filename> | +
| + | +use the given file as configuration file instead of +~/.hatari/hatari.cfg + | +
| + | +−−fast-forward <bool> | +
| + | +On fast machine helps skipping (fast forwarding) Hatari +output + | +
Display options
+| + | +−m, −−mono | +
| + | +Start in monochrome mode instead of color + | +
| + | +−−monitor <x> | +
| + | +Select monitor type (x = mono/rgb/vga/tv) + |
Using the emulated system
+| + | +−f, −−fullscreen | +
| + | +Start the emulator in fullscreen mode + | +
| + | +−w, −−window | +
| + | +Start the emulator in window mode + | +
| + | +−z, −−zoom <x> | +
| + | +Zoom low resolution (1=no, 2=yes) + | +
| + | +−−frameskips <x> | +
| + | +Skip <x> frames after each displayed frame to +accelerate emulation (0=disabled, >4 uses automatic +frameskip with given value as maximum) + | +
| + | +−−borders <bool> | +
| + | +Show screen borders (for overscan demos, ST(e) color mode +specific etc) + | +
| + | +−−statusbar <bool> | +
| + | +Show statusbar (with floppy leds etc etc) + | +
| + | +−−drive-led <bool> | +
| + | +Show overlay drive led when statusbar isn’t +shown + | +
| + | +−−spec512 <x> | +
| + | +Hatari uses this threshold to decide when to render a +screen with the slower but more accurate Spectrum512 screen +conversion functions (0 <= x <= 512, 0=disable) + | +
| + | +−−bpp <bool> | +
| + | +Force internal bitdepth (x = 8/15/16/32, 0=disable) + | +
VDI options
+| + | +−−vdi <bool> | +
| + | +Whether to use VDI screen mode + | +
| + | +−−vdi−planes <x> | +
| + | +Use extended VDI resolution with bit depth <x> (x = +1, 2 or 4) + | +
| + | +−−vdi−width <w> | +
| + | +Use extended VDI resolution with width <w> (384 +<= w <= 1024) + | +
| + | +−−vdi−height <h> | +
| + | +Use extended VDI resolution with height <h> (200 +< h <= 768) + | +
Devices options
+| + | +−j, −−joystick +<port> | +
| + | +Emulate joystick with cursor keys in given port (0-5) + | +
| + | +−−joy<port> +<type> | +
| + | +Set joystick type (none/keys/real) for given port + | +
| + | +−−printer <file> | +
| + | +Enable printer support and write data to <file> + | +
| + | +−−midi <filename> | +
| + | +Enable midi support and write midi data to +<file> + | +
| + | +−−rs232 <filename> | +
| + | +Enable serial port support and use <file> as the +device + | +
Disk options
+| + | +−−disk-a <file> | +
| + | +Set disk image for floppy drive A + | +
| + | +−−disk-b <file> | +
| + | +Set disk image for floppy drive B + | +
| + | +−d, −−harddrive +<dir> | +
| + | +Emulate an ST harddrive (<dir> = root +directory) + | +
| + | +−−acsi <file> | +
| + | +Emulate an ACSI hard disk with an image <file> + | +
| + | +−−ide <file> | +
| + | +Emulate an IDE hard disk with an image <file> (not +working yet) + | +
| + | +−−slowfdc <bool> | +
| + | +slow down FDC emulation (deprecated) + | +
Memory options
+| + | +−s, −−memsize <x> | +
| + | +Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 +KiB + | +
| + | +−t, −−tos +<imagefile> | +
| + | +Specify TOS ROM image to use + | +
| + | +−−cartridge <imagefile> | +
| + | +Use ROM cartridge image <file> (only works if +GEMDOS HD emulation and extended VDI resolution are +disabled) + | +
| + | +−−memstate <file> | +
| + | +Load memory snap-shot <file> + | +
CPU options
+| + | +−−cpulevel <x> | +
| + | +Specify CPU (680x0) to use (use x >= 1 with EmuTOS or +TOS >= 2.06 only!) + | +
| + | +−−cpuclock <x> | +
| + | +Set the CPU clock (8, 16 or 32 Mhz) + | +
| + | +−−compatible <bool> | +
| + | +Use a more compatible but slower 68000 CPU mode + | +
Misc system options
+| + | +−−machine <x> | +
| + | +select machine type (x = st, ste, tt or falcon) + | +
| + | +−−blitter <bool> | +
| + | +Enable blitter emulation (ST only) + | +
| + | +−−dsp <x> | +
| + | +Falcon DSP emulation (x = none, dummy or emu, Falcon +only) + | +
| + | +−−sound <x> | +
| + | +Sound quality (off/low/med/hi, off=faster) + | +
| + | +−k, −−keymap +<file> | +
| + | +load keyboard mapping from <file> + | +
Debug options
+| + | +−D, −−debug +<bool> | +
| + | +Enable Hatari debugger console interface + | +
| + | +−−bios-intercept | +
| + | +Enable Bios/XBios interception + | +
| + | +−−trace <trace1,...> | +
| + | +Activate debug traces, see --trace help for available tracing options + | +
| + | +−−control-socket <file> | +
| + | +Hatari reads options from given socket at run-time + | +
| + | +−−log-file <file> | +
| + | +Save log output to <file> (default=stderr) + | +
| + | +−−log-level <x> | +
| + | +Log output level (x=debug/todo/info/warn/error/fatal) + | +
| + | +−−alert-level <x> | +
| + | +Show dialog for log messages above given level + | +
Type hatari --help to list all +the command line options supported by a given version of Hatari.
+ +Using the emulated system
+Once you've started Hatari succesfully, you can use the emulator as an allmost complete Atari ST computer system.
-The GUI
-General usage
+ +The GUI
+Press F12 to enter the GUI. Navigate it with the mouse. The GUI is rather self explanatory.
+ +The Main Menu
+ +
+From the main menu, you can reach the other setup dialogs by clicking on +the appropriate buttons.
+ +You can load the current settings from a configuration file by clicking +on the button and you can save the +current settings to a configuration file with the button.
+Click to go back to the emulated -ST. All checked options will be applied.
+ST. All changed options will be applied.Check the option if you want -the emulated ST to perform a soft reset. This should be equal to -pressing the reset button on your ST. +the emulated ST to perform a cold reset. This is equal to +switching the power off and on again on a real ST.
Click to terminate Hatari and return to the host OS.
Click to abandon any changes -made.
-The System Dialog
-Check the CPU type to use here, enable prefetch mode and if the -Blitter should be active.
-For best Atari ST compatibility choose plain 68000 here.
-The Timer-D patch changes the Timer-D initialization from TOS. TOS -uses Timer-D as a baudrate generator for RS232. -The TOS default slows the emulation down so the patch gives you a -faster emulation. +that you have made.
+ +The System Dialog
+ +
++ First you can select the CPU type here. Here are some important hints for + choosing the correct CPU type: +
+-
+
- + Atari ST and STE have only been shipped with a 68000 CPU, so for best + compatibility with old programs, choose this CPU type. + +
- + Atari TT and Falcon computers were using the 68030 CPU, so you should switch + either to 68020 or 68020+FPU when you want to use TT or Falcon mode. + (The 68020 and 68030 were pretty much the same apart from some minor details). + +
- + TOS 1.0x only works with 68000, while TOS 3.0x and 4.0x work only with a CPU + >= 68020. + +
- + 68010 and 68040 have never been used in official Atari computers, so don't + use these CPU types unless you've got some good reasons. + +
+ Beside the CPU type, you can also choose the machine type to emulate.
+ The ST was the very first 16/32-bit computer from Atari. Most older games
+ and demos require an ST. The STE was introduced some years later and had
+ some more advanced hardware features. There are not that many demos or
+ games that really require an STE but since most normal ST games/demos also
+ work with an STE, it's normally safe to always work in STE mode.
+
+ TT and Falcon are more advanced, but they are not as compatible to the ST as
+ the STE was. Therefore many old games and demos do not work with these machine
+ types anymore. There were only very few programs that were made for the TT
+ exclusively, while there were some interesting games and demos specially made
+ for the Falcon.
+ Note: TT and Falcon emulation are very incomplete. They may not work
+ very well.
+
+ For STE emulation a STE compatible TOS image, e.q. version 1.06, 1.62 or + 2.x, is strongly recommended. For TT emulation you need TOS 3.0x and for Falcon + emulation you need TOS 4.0x. EmuTOS can be used on all machine types. +
++ Select the CPU clock you want to use. 8Mhz is ST standard and the most + compatible. Use 16MHz for Mega STE and Falcon emulation. + The CPU in the TT was clocked with 32 MHz. +
+With the "Slower but more compatible CPU" option, you can enable + the emulation of 68k address errors and the CPU prefetch buffer. This is needed + for best compatibility, but it slows down emulation a little bit so you can + disable it if you don't need it.
+You can also enable/disable Blitter emulation here. The Blitter is a custom + chip that accelerates some graphical operations. This switch only toggles the + Blitter in plain ST mode. In STE mode, the Blitter is always enabled (since all + STEs have been sold with a Blitter chip).
+If you enable the "Real time clock emulation" switch, a RTC will + be emulated based on the time of the host computer. Note that you need at least + TOS 1.02 for proper RTC emulation, TOS 1.00 does not support this.
+The Timer-D patch changes the Timer-D initialization from TOS. TOS uses + the MFP timer D as a baudrate generator for RS232. However, the TOS default + value slows down the emulation. The patch gives you a better performance. + It is normally safe to enable the patch, but if you encounter a program that + does not work, you can try to disable the patch to see if it works then.
++ Select if you want to use slow FDC emulation. "Slow down FDC" is + normally not required, except for some few slideshows / intros which run too + fast without this option.
-You can disable the Timer-D patch if games or demos require the -original TOS setting.
NOTE: These parameters are very sensitive to the emulated ST and it is strongly recommended to reset the emulated ST after changing these options.
-The Discs Dialog
+ +The Disks Dialog
+ +
+Use the upper dialog to choose which floppy disks should be emulated in the disk drives.
-You can use most standard Atari ST disk image files. See the chapter -"Floppy disk images" + +
You can use most standard Atari ST disk image files. You may select +and browse also zipped disk images. See the chapter "Floppy disk images" for details.
+Click on the button next to the -A: and B: option to go to the fileselector. -You may select and browse zipped disk images as well.
+A: and B: option to go to the fileselector: + + +
+Click on to eject a disk image from the emulated drive. The emulated ST will act as if had no floppy disk in its drive.
You can specify a default directory where Hatari will start to browse the filesystem.
-Check the "Auto insert B" option if you want Hatari to be smart and -insert the second disk -of a two disk game automatically. This option will insert the second -disk in drive B and some -games may not be able to find the disks there. In that rare case you -will need to insert the -second disk manually when prompted.
-NOTE: This option does not always work properly.
+Check the "Auto insert B" option if you want Hatari to be smart and
+insert the second disk of a two disk game automatically.
+Some games then use the second drive automatically.
+In the case that a game is not able to find the disk in the second drive,
+you have to insert the second disk in drive A: manually when prompted.
+
+NOTE: This option only works properly if the file name of the
+first disks ends with an 'a' before the extension and the second disk name
+ends with a 'b'.
If you need to create a new blank disk image, click on . @@ -418,6 +1332,8 @@ with .st or .msa.
Hatari can currently create plain .ST and .MSA disk images exclusively.
+You can choose if you want Hatari to writeprotect your disks. Atari ST virii can spread on disk images too so it is ok to +enable the write protection option. However you can't save highscores or games to your disk images then.
Use the lower dialog to change the harddisk settings.
You can select a harddrive image for harddrive emulation via image file here or you may select @@ -427,7 +1343,13 @@ harddrive.
on the harddrive. This option is checked by default if you specify a harddrive image or a directory via the command line. -The Memory Dialog
+ +The Memory Dialog
+ +
+You can select the amount of RAM for the emulated ST here. Only amounts that were valid on a real unmodified STFM can be selected.
Note: This option is critical and you are strongly advised @@ -443,53 +1365,133 @@ restored.
different versions of Hatari. E.q. if you compile a newer Hatari, you cannot load your old memory snapshots back. -The ROM Dialog
+ +The ROM Dialog
+ +
+Here you can select the TOS image to use. Click on to select it via the fileselector.
+ class="button">Browse to select it via the fileselector. You can also select an optional cartridge image to use. Click on to select one via the fileselector. Keep -in mind that any custom cartridge image will not work together with -GEMDOS harddisc emulation or the VDI extended resolution emulation + class="button">Browse to select one via the fileselector. Click on to disconnect the custom cartridge image. + ++For ST mode, use TOS 1.00, 1.02, 1.04 or 2.06. +For STE mode, use TOS 1.06, 1.62, 2.05 or 2.06. +If you want to use the TT mode, you must specify a TOS 3.06 image here. +And in Falcon mode, you have to use either TOS 4.00, 4.02, 4.04 or 4.92. +However, you should always use TOS 4.04 for Falcon mode, it's the most common one. +Also note that TOS 4.92 can not be booted from a boot disk (like it's done on a +real Falcon), you have to specify it directly in the TOS ROM setup dialog here. +
+
+Keep in mind that any custom cartridge image will not work together with
+GEMDOS hard disk emulation or the VDI extended resolution emulation
since some additional driver code will be used in the cartridge memory
-space for these emulations.
-
Note: These options are critical and you are strongly +space for these emulations. +
++Note: These options are critical and you are strongly advised to reset the emulated ST -when changing one of these option.
-The Joystick Dialog
-Here you can select which joystick you want to emulate via the -cursor keys.
+when changing one of these option. + + + +The Joystick Dialog
+ +
+In this dialog, you can configure the emulated joysticks. +With the upper two arrows, you can choose the joystick which you want to +configure.
Joystick 1 is the normal ST joystick port and 99.9% of all ST games -use this port, Joystick 0 -emulates a joystick plugged into the ST mouse port allowing you to play -2 player games.
-If no joystick is checked here, joystick emulation is done via a -connected PC joystick.
-See the chapter "Emulated Joystick" for details.
- -The Screen Dialog
-Here you control the video output of the emulated ST.
-Check "Fullscreen" to run Hatari fullscreen, default is windowed.
-Check "Interleaved mode" if you wish to have that old TV feeling in -Hatari. Every second line will be black. -This will only work in ST-MEDIUM or ST-LOW in scaled up resolutions.
-Check "Frame Skip" to speed Hatari up if emulation is too slow. This -will only draw every second ST frame -instead of the default of drawing every ST frame. Uncheck if you have a -fast PC.
-Check "Use Borders" if you wish to have the borders around the ST -screen.
-"Force 8Bpp" will force SDL to use an 8bit video mode. You don't -need this for modern video cards.
-You can select which sort of monitor to use. Check "Color" for games -and demos. If you check "Mono" here, -Hatari will emulate the good old SM124 and will not allow you to switch -to color modes from the running ST. -This toggle acts like a monitor switch with a color and monochrome -monitor connected.
-"Zoom ST-Low res." will control if Hatari renders ST-LOW to a -320x200 or 640x400 PC display (with borders turned off) or 384x267 or -768x534. -Basically select this to toggle between a small or a large window.
+use this port. +Joystick 0 emulates a joystick plugged into the ST mouse port +and is often used in games for two players. +With STE joypad A and B, you can enable the emulation of Jaguar joypads +which are plugged in the enhanced joystick ports of the Atari STE. +Only very few STE games support these joypads, so you often won't need this.
+Finally, Hatari also emulates joysticks which were plugged on the parallel +port with a special adapter on a real ST. These were used in some few +multi-player games like "Gauntlet 2".
+For each ST joystick, choose whether you want to disable it, +use the keyboard for emulation or use a real PC joystick.
+For keyboard emulation, you can select the keys by pressing the + button. You will be prompted to press +the keys for up, down, left, right and fire.
+If you want to use a real PC joystick for the emulation, you should connect +it to your PC before you start Hatari. Then you can choose the joystick with +the two lower arrows.
+Check the "Enable autofire" option if you are too lazy to pound +on the fire button in shoot'em-up games. However, this option only works with +certain games. In some other games, it gets worse if you enable this option.
+See also the chapter "Emulated Joystick" for details.
+ + +The Screen Dialog
+ +
++ Here you control the video output of the emulated Atari. +
++ Check "Fullscreen" to run Hatari fullscreen, default is windowed. +
++ "Use Borders" toggles the displaying of the borders around the ST + screen. Some few demos/games use the borders for displaying additional + graphics. However, when you enable this option, it increases CPU computing + time, so you should not enable it if you have a slow computer. + Please note that this option also only affects the ST and STE mode, TT and + Falcon modes are always displayed without borders. +
++ "Zoom ST-Low res." controls whether Hatari doubles the low + resolutions. For example Hatari then zooms the ST low resolution 320x200 to + 640x400 and it doubles 384x267 (ST low with borders) to 768x534. + Note that zooming also takes a lot of CPU computing time and should not be + enabled on slow computers. +
++ "Statusbar" toggles the statusbar at the bottom of the screen. + The statusbar shows the floppy drive LEDs, the current frameskip value, + the machine type including TOS version and memory size, and whether + recording is currently active. +
+
+ The "Frame Skip" option can be set to speed up the emulator
+ if it is running too slow on your system. Disable frame-skip if you have
+ a fast computer. When selecting 1, 2 or 4, drawing of corresponding number
+ of frames will be skipped after each frame actually shown by Hatari.
+ Select "Auto" to let the emulator to decide whether, and
+ how many frames will be skipped.
+ Note: The frameskip option also affects the frame rate of the
+ screen animation recording!
+
+ You can select which sort of monitor to use. This option depends on the
+ machine type which you have selected in the "System options"
+ dialog. In ST and STE mode, you can choose between monochrome mode (select
+ "Mono") and color mode (select one of the other monitor types).
+ Note that when you select "TV" and use zoomed low resolution or
+ switch to ST medium resolution, you will get a TV-like screen rendering
+ which is a little bit faster but darker compared to the normal "RGB"
+ monitor mode. Switching between mono and a color monitor acts like a monitor
+ switch on a real ST - so beware, this will reboot your emulated system!
+ In TT mode, you can only choose between TT-high resolution ("Mono")
+ and normal modes (select one of the other monitor types).
+ Finally the Falcon mode supports all four types of monitors. Note that most
+ Falcon demos/games require a RGB or TV mode and do not work with VGA.
+
Extended GEM resolutions will emulate some sort of extended graphics
card in the emulated ST giving you larger resolutions and a higher
colordepth in GEM. Select a resolution and color depth. Check to
@@ -497,44 +1499,79 @@ activate. It will disable all other vide
Uncheck to get back to a normal ST behaviour.
Note: Using an extended resolution will only work with GEM
conformant applications. 99% of all games and demos will not run if you
-activate any extended resolution here.
+activate any extended resolution here.
+
Click to create a -screenshot in .BMP format to the current working directory or click to record a sequence of single +screenshot in PNG (or BMP) format to the current working directory or click + to record a sequence of single screenshots. You can opt to only record new movie frames when the screen content really changed.
-The Keyboard Dialog
-Here you can select the keyboard mapping to use.
-Two different mappings called "Symbolic" and "Scancode" are -predefined.
-You can also load a custom keymapping file here if you wish. Please -note that selecting to use a custom keyboard mapping will -use the "symbolic" mapping for all keys not defined by your map file. -See the supplied example mapfile on how to build your -own keyboard mapping.
-The Sound Dialog
+ + +The Keyboard Dialog
+ +
+Here you can select the keyboard mapping to use. Two different mappings + called "Symbolic" and "Scancode" are predefined.
+"Symbolic" tries to map the symbolic values of your PC keys + to the ST keys. It should be working pretty good on all systems as long + as your keyboard layout looks close to the standard english keyboard + layout. However, you might experience some problems with special keys like + brackets etc.
+"Scancode" uses the scancode values of your PC keys for keyboard + mapping. This only works on certain architectures like Linux where the + scancodes are similar to the ST scancodes (e.g. it does not work on Mac OS X). + If it works on your system, this often gives better results than the symbolic + mapping. Note that you also need a TOS version with the right language + (e.g. use a French TOS if you are using a French keyboard).
+You can also load a custom keyboard mapping file here if you wish. Please + note that the custom keyboard mapping will use the "symbolic" + mapping for all keys that are not defined by your map file. Have a look + at the supplied example mapfile (keymap-sample.txt) to see how to create + your own keyboard mapping.
++ When the emulator runs in fast forward mode, and you want to type text, + it can be annoying that the emulated system detects multiple key events + due to the key repetition of the emulated system. To avoid this you can + disable the key repetition in fast forward mode here. +
+ + +The Sound Dialog
+ +
+Here you can control the sound subsystem.
Check if you want emulated sound at all. Emulation is faster if sound emulation is turned off.
3 frequencies from low to high quality are available. Experiment a little bit to find out which fits best for your setup. Medium quality will work ok in most cases.
-You can select to record a piece of sound here. Check which format -to use and click the button. It is a toggle button so -you will need to return to the GUI to switch sound recording off again.
-The Devices Dialog
+You can select to record a piece of sound here. The file name +extension you use (.WAV or .YM), determines in which format the sound +is recorded in. The record button is a toggle so you will need to +return to the GUI to switch sound recording off again +(or to use the keyboard shortcut for that).
+ + +The Devices Dialog
+ +
+Check here if you want to enable experimental printer support. See the chapter "Emulated printer" for details.
+As Hatari currently only supports printing to file, click on to select the file to print to. You can enter a new filename as well.
-NOTE: As the printer emulation is not perfect yet, -activated printer support may interfere with the emulated sound. -This is due to the fact that the Atari ST uses some general I/O ports -of the soundchip for the printer port. The Hatari team suggests to -disable printing while using games and demos. -
Check the second checkmark if you want to enable experimental RS232 support. The RS232 device is configured according to the settings of the emulated RS232 of the Atari ST. This means Hatari will @@ -552,9 +1589,13 @@ MIDI device file for output.
NOTE: RS232 and MIDI emulation are very experimental, too. Don't enable them unless you really need them!
-Keyboard shortcuts
+ + +Keyboard shortcuts
+While the emulator is running, you can activate or toggle various -features via the following keyboard shortcuts.
+features via Hatari keyboard shortcuts. Below are listed the default +shortcut key bindings:| ALTGR+g | -grabs a screenshot | +grab a screenshot | |
| ALTGR+i | -boss key: leave full screen mode and iconify -window | +boss key: leave full screen mode, pause Hatari +and iconify its window | |
| ALTGR+j | -activates joystick emulation via cursor keys | +toggle joystick emulation via cursor keys +on/off between ports 0 and 1 | |
| ALTGR+m | -(un-)locks the mouse into the window | +(un-)lock the mouse into the window | |
| ALTGR+r | @@ -592,6 +1634,10 @@ window switch)|||
| ALTGR+d | +open dialog to select/change disk A | +||
| ALTGR+s | enable/disable sound | enable/disable sound recording | |
| F11 | -toggles fullscreen and windowed mode | +ALTGR+k | +save memory snapshot |
| F12 | -
- activate the GUI -You may need to hold SHIFT down -while in windowed mode. - |
+ ALTGR+l | +load memory snapshot | +
| ALTGR+f or F11 | +toggle between fullscreen and windowed mode | +||
| ALTGR+o or F12 | +activate the options GUI | ||
| PAUSE | -will go to the debugger if it was activated at -compile time | +pause emulation or go to the debugger + if Hatari was started with the -D option |
Emulated Atari ST keyboard
+ +You can change the key bindings from the Hatari configuration file. +The required key values you can see from the SDL_keysym.h include file +(usually in /usr/include/SDL/).
+ + +Emulated Atari ST keyboard
+All other keys on the keyboard act as the normal Atari ST keys so pressing SPACE on your PC will result in an emulated press of the SPACE key on the ST. The following keys have special meanings:
@@ -662,16 +1719,15 @@ key on the ST. The following keys have s