1HATARI(1)                                                            HATARI(1)
2
3
4

NAME

6       hatari - Atari ST/STE/TT/Falcon emulator
7

SYNOPSIS

9       hatari [options] [directory|diskimage|program]
10

DESCRIPTION

12       Hatari  is  an Atari ST/STE/TT/Falcon emulator for Linux, FreeBSD, BeOS
13       and other Systems which are supported by the SDL library.
14
15       With hatari one can run games, demos or applications written for  Atari
16       ST,  STE or Falcon.  Atari TT support is experimental.  Hatari supports
17       the commonly used *.st and *.msa disk images and hard disk emulation.
18
19       To run the emulator a TOS ROM image is needed. EmuTOS, a free implemen‐
20       tation of TOS is shipped with hatari. Since it is not yet fully compat‐
21       ible with the original TOS, some programs won't run correctly with  it.
22       Because of this it is recommended to use a TOS ROM from a real Atari.
23
24       As an argument one can give either a name of a directory that should be
25       emulated as a virtual GEMDOS hard disk, a floppy disk image or an Atari
26       program  that  should  be  autostarted.  In the last case the program's
27       directory will be used as the C: drive from where this program will  be
28       started.
29
30       Note  that  autostarting a program might not work if you've also speci‐
31       fied a floppy image for drive A: (on command line or  in  config  file)
32       which contains a desktop.inf/newdesk.inf/emutos.inf file on it.
33
34       Booting will be done from the disk image or directory that's given last
35       on the command line as an option or the argument (and which corresponds
36       to A: or C:).
37

OPTIONS

39       Hatari options are split into several categories:
40

General options

42       -h, --help
43              Print command line options and terminate
44
45       -v, --version
46              Print version information and terminate
47
48       --confirm-quit <bool>
49              Whether Hatari confirms quitting
50
51       -c, --configfile <filename>
52              use   the   given   file   as   configuration  file  instead  of
53              ~/.hatari/hatari.cfg
54
55       -k, --keymap <file>
56              load keyboard mapping from <file>
57
58       --fast-forward <bool>
59              On fast machine helps skipping (fast forwarding) Hatari output
60

Common display options

62       -m, --mono
63              Start in monochrome mode instead of color
64
65       --monitor <x>
66              Select monitor type (x = mono/rgb/vga/tv)
67
68       -f, --fullscreen
69              Start the emulator in fullscreen mode
70
71       -w, --window
72              Start the emulator in window mode
73
74       --grab Grab mouse (also) in window mode
75
76       --frameskips <x>
77              Skip <x> frames after each displayed frame to accelerate  emula‐
78              tion  (0=disabled,  >4 uses automatic frameskip with given value
79              as maximum)
80
81       --statusbar <bool>
82              Show statusbar (with floppy leds etc etc)
83
84       --drive-led <bool>
85              Show overlay drive led when statusbar isn't shown
86
87       --bpp <bool>
88              Force internal bitdepth (x = 8/15/16/32, 0=disable)
89

ST/STE specific display options

91       --borders <bool>
92              Show ST/STE screen  borders  (for  low/med  resolution  overscan
93              demos)
94
95       --spec512 <x>
96              Hatari  uses  this  threshold  to decide when to render a screen
97              with the slower but more accurate Spectrum512 screen  conversion
98              functions (0 <= x <= 512, 0=disable)
99
100       -z, --zoom <x>
101              Zoom (double) low resolution (1=no, 2=yes)
102

Falcon/TT specific display options

104       Zooming to sizes specified below is internally done using integer scal‐
105       ing factors. This means that different Atari resolutions  may  show  up
106       with different sizes, but they are never blurry.
107
108       --desktop <bool>
109              Whether  to use desktop resolution on fullscreen to avoid issues
110              related to resolution switching. Otherwise fullscreen will use a
111              resolution that is closest to the Hatari window size
112
113       --max-width <x>
114              Preferred / maximum window width
115
116       --max-height <x>
117              Preferred / maximum window height
118
119       --aspect <bool>
120              Whether  to  do  monitor  aspect  ratio  correction  (enabled by
121              default)
122

VDI options

124       --vdi <bool>
125              Whether to use VDI screen mode
126
127       --vdi-planes <x>
128              Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
129
130       --vdi-width <w>
131              Use extended VDI resolution with width <w> (320 < w <= 1280)
132
133       --vdi-height <h>
134              Use extended VDI resolution with height <h> (200 < h <= 960)
135

Screen capture options

137       --crop <bool>
138              Remove statusbar from the screen captures
139
140       --avirecord
141              Start AVI recording
142
143       --avi-vcodec <x>
144              Select avi video codec (x = bmp/png)
145
146       --avi-fps <x>
147              Force avi frame rate (x = 50/60/71/...)
148
149       --avi-file <file>
150              Use <file> to record avi
151

Devices options

153       -j, --joystick <port>
154              Emulate joystick with cursor keys in given port (0-5)
155
156       --joy<port> <type>
157              Set joystick type (none/keys/real) for given port
158
159       --printer <file>
160              Enable printer support and write data to <file>
161
162       --midi-in <filename>
163              Enable MIDI support and write MIDI data to <file>
164
165       --midi-out <filename>
166              Enable MIDI support and read MIDI data from <file>
167
168       --rs232-in <filename>
169              Enable serial port support and use <file> as the input device
170
171       --rs232-out <filename>
172              Enable serial port support and use <file> as the output device
173

Disk options

175       --disk-a <file>
176              Set disk image for floppy drive A
177
178       --disk-b <file>
179              Set disk image for floppy drive B
180
181       --protect-floppy <x>
182              Write protect floppy image contents (on/off/auto).  With  "auto"
183              option  write  protection  is  according  to the disk image file
184              attributes.
185
186       --protect-hd <x>
187              Write  protect  harddrive  <dir>  contents  (on/off/auto).  With
188              "auto"  option the protection can be controlled by setting indi‐
189              vidual files attributes as it disables the file attribute  modi‐
190              fications for the GEMDOS hard disk emulation.
191
192       -d, --harddrive <dir>
193              Emulate harddrive partition(s) with <dir> contents
194
195       --acsi <file>
196              Emulate an ACSI hard disk with an image <file>
197
198       --ide-master <file>
199              Emulate an IDE master hard disk with an image <file>
200
201       --ide-slave <file>
202              Emulate an IDE slave hard disk with an image <file>
203
204       --slowfdc <bool>
205              slow down FDC emulation (deprecated)
206

Memory options

208       -s, --memsize <x>
209              Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 KiB
210
211       -t, --tos <imagefile>
212              Specify TOS ROM image to use
213
214       --cartridge <imagefile>
215              Use  ROM  cartridge image <file> (only works if GEMDOS HD emula‐
216              tion and extended VDI resolution are disabled)
217
218       --memstate <file>
219              Load memory snap-shot <file>
220

CPU options

222       --cpulevel <x>
223              Specify CPU (680x0) to use (use x >= 1 with  EmuTOS  or  TOS  >=
224              2.06 only!)
225
226       --cpuclock <x>
227              Set the CPU clock (8, 16 or 32 Mhz)
228
229       --compatible <bool>
230              Use  a  more  compatible,  but slower 68000 CPU mode with better
231              prefetch accuracy and cycle counting
232

Misc system options

234       --machine <x>
235              Select machine type (x = st, ste, tt or falcon)
236
237       --blitter <bool>
238              Enable blitter emulation (ST only)
239
240       --dsp <x>
241              Falcon DSP emulation (x = none, dummy or emu, Falcon only)
242
243       --mic <bool>
244              Enable/disable (Falcon only) microphone
245
246       --sound <x>
247              Sound frequency: 6000-50066. "off" disables the sound and speeds
248              up  the  emulation.  To  prevent extra sound artifacts, the fre‐
249              quency should be selected so that it either matches evenly  with
250              the  STE/TT/Falcon  sound DMA (6258, 12517, 250033, 50066 Hz) or
251              your sound card frequencies (11025, 22050, 44100 or 6000...48000
252              Hz).  Check what your sound card supports.
253
254       --sound-buffer-size <x>
255              SDL's  sound  buffer  size:  10-100,  or 0 to use default buffer
256              size.  By default Hatari uses an SDL buffer size  of  1024  sam‐
257              ples, which gives approximatively 20-30 ms of sound depending on
258              the chosen sound frequency. Under some OS or with not fully sup‐
259              ported sound card, this default setting can cause a bigger delay
260              at lower frequency (nearly 0.5 sec).  In that case, you can  use
261              this  option  to  force  the size of the sound buffer to a fixed
262              number of milliseconds of sound (using 20 is often a good choice
263              if  you  have  such  problems).  Most  users  will not need this
264              option.
265
266       --ym-mixing <x>
267              Select a method  for  mixing  the  three  YM2149  voice  volumes
268              together.   "table"  uses a lookup table of audio output voltage
269              values measured on STF and  "linear"  just  averages  the  3  YM
270              voices.
271
272       --timer-d <bool>
273              Patch redundantly high Timer-D frequency set by TOS.  This about
274              doubles Hatari speed (for ST/e emulation) as the original Timer-
275              D frequency causes most of the interrupts.
276
277       --rtc <bool>
278              Enable real-time clock
279

Debug options

281       -D, --debug
282              Toggle whether CPU exceptions invoke the debugger
283
284       --bios-intercept
285              Toggle  Bios/XBios  call interception and BIOS CON: output (e.g.
286              EmuTOS  console)  redirection  to  host  terminal.   Needed  for
287              Bios/XBios  call tracing. Allows Atari programs to modify Hatari
288              state through XBios 255 calls.
289
290       --trace <trace1,...>
291              Activate debug traces, see --trace help  for  available  tracing
292              options
293
294       --trace-file <file>
295              Save trace output to <file> (default=stderr)
296
297       --parse <file>
298              Parse/execute debugger commands from <file>
299
300       --saveconfig
301              Save  Hatari configuration and exit. Hatari UI needs Hatari con‐
302              figuration file to start, this can be used to create it automat‐
303              ically.
304
305       --no-parachute
306              Disable SDL parachute to get Hatari core dumps. SDL parachute is
307              enabled by default to restore video mode in case  Hatari  termi‐
308              nates abnormally while using non-standard screen resolution.
309
310       --control-socket <file>
311              Hatari reads options from given socket at run-time
312
313       --log-file <file>
314              Save log output to <file> (default=stderr)
315
316       --log-level <x>
317              Log output level (x=debug/todo/info/warn/error/fatal)
318
319       --alert-level <x>
320              Show dialog for log messages above given level
321
322       --run-vbls <x>
323              Exit after X VBLs
324

COMMANDS

326       The  shortcut  keys  can  be configured in the configuration file.  The
327       default settings are:
328
329       AltGr + a
330              record animation
331
332       AltGr + g
333              grab a screenshot
334
335       AltGr + i
336              boss key: leave full screen mode and iconify window
337
338       AltGr + j
339              activate joystick emulation via cursor keys
340
341       AltGr + m
342              (un-)lock the mouse into the window
343
344       AltGr + r
345              warm reset the ST (same as the reset button)
346
347       AltGr + c
348              cold reset the ST (same as the power switch)
349
350       AltGr + d
351              open dialog to select/change disk A
352
353       AltGr + s
354              enable/disable sound
355
356       AltGr + q
357              quit the emulator
358
359       AltGr + x
360              toggle normal/max speed
361
362       AltGr + y
363              enable/disable sound recording
364
365       AltGr + k
366              save memory snapshot
367
368       AltGr + l
369              load memory snapshot
370
371       F11    toggle between fullscreen and windowed mode
372
373       F12    activate the hatari options GUI
374              You may need to hold SHIFT down while in windowed mode.
375
376       Pause  Pauses the emulation
377
378       AltGr + Pause
379              Invokes the internal Hatari debugger
380
381

Emulated Atari ST keyboard

383       All other keys on the keyboard act as  the  normal  Atari  ST  keys  so
384       pressing SPACE on your PC will result in an emulated press of the SPACE
385       key on the ST. The following keys have special meanings:
386
387       Alt    will act as the ST's ALTERNATE key
388
389       left Ctrl
390              will act as the ST's CONTROL key
391
392       Page Up
393              will emulate the ST's HELP key
394
395       Page Down
396              will emulate the ST's UNDO key
397
398       AltGr will act as Alternate as well as long as  you  do  not  press  it
399       together with a Hatari hotkey combination.
400
401       The  right Ctrl key is used as the fire button of the emulated joystick
402       when you turn on joystick emulation via keyboard.
403
404       The cursor keys will act as the cursor keys on the Atari ST as long  as
405       joystick emulation via keyboard has been turned off.
406
407

SEE ALSO

409       The  main  program  documentation,  usually  in /usr/share/doc/.  Among
410       other things it contains an extensive usage manual, software  compatib‐
411       lity list and release notes.
412
413       The homepage of hatari: http://hatari.berlios.de/
414
415       Other Hatari programs and utilities:
416       hmsa(1), zip2st(1), atari-hd-image(1), hatariui(1), hconsole(1)
417

FILES AND DIRECTORIES

419       /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
420              The global configuration file of Hatari.
421
422       ~/.hatari/
423              The  (default)  directory  for  user's  personal  Hatari  files;
424              hatari.cfg (configuration  file),  hatari.nvram  (NVRAM  content
425              file),  hatari.sav  (Hatari  memory  state  snapshot  file which
426              Hatari  can  load/save  automatically  when  it   starts/exits),
427              hatari.prn  (printer  output  file),  hatari.wav (recorded sound
428              output in WAV format), hatari.ym (recorded sound  output  in  YM
429              format).
430
431       /usr/share/hatari/ (or /usr/local/share/hatari/)
432              The global data directory of Hatari.
433
434       tos.img
435              The  TOS  ROM  image  will  be loaded from the data directory of
436              Hatari unless it is specified on the command line or the config‐
437              uration file.
438
439

AUTHOR

441       This  manual  page was written by Marco Herrn <marco@mherrn.de> for the
442       Debian project and later modified by Thomas Huth and Eero  Tamminen  to
443       suit the latest version of Hatari.
444
445
446
447Hatari                            2011-05-09                         HATARI(1)
Impressum