![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to hatari.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [HATARI the Atari ST Emulator] / hatari / doc|
Return to hatari.1 CVS log | Up to [HATARI the Atari ST Emulator] / hatari / doc |
1.1 root 1: .\" Hey, EMACS: -*- nroff -*-
2: .\" First parameter, NAME, should be all caps
3: .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4: .\" other parameters are allowed: see man(7), man(1)
1.1.1.10 root 5: .TH "HATARI" "1" "2011-12-30" "Hatari" ""
1.1 root 6: .\" Please adjust this date whenever revising the manpage.
7:
8: .SH "NAME"
1.1.1.5 root 9: hatari \- Atari ST/STE/TT/Falcon emulator
1.1 root 10: .SH "SYNOPSIS"
11: .B hatari
12: .RI [options]
1.1.1.9 root 13: .RI [directory|diskimage|program]
1.1 root 14: .SH "DESCRIPTION"
1.1.1.5 root 15: Hatari is an Atari ST/STE/TT/Falcon emulator for Linux, FreeBSD, BeOS and
16: other Systems which are supported by the SDL library.
1.1 root 17: .PP
1.1.1.3 root 18: With hatari one can run games, demos or applications written for Atari
1.1.1.8 root 19: ST, STE or Falcon. Atari TT support is experimental. Hatari supports
1.1.1.5 root 20: the commonly used *.st and *.msa disk images and hard disk emulation.
1.1 root 21: .PP
1.1.1.3 root 22: To run the emulator a TOS ROM image is needed. EmuTOS, a free
23: implementation of TOS is shipped with hatari. Since it is not yet
1.1.1.9 root 24: fully compatible with the original TOS, some programs won't run
25: correctly with it. Because of this it is recommended to use a TOS
1.1.1.3 root 26: ROM from a real Atari.
1.1.1.9 root 27: .PP
28: As an argument one can give either a name of a directory that should
29: be emulated as a virtual GEMDOS hard disk, a floppy disk image or an
30: Atari program that should be autostarted. In the last case the
31: program's directory will be used as the C: drive from where this
32: program will be started.
33: .PP
34: Note that autostarting a program might not work if you've also
35: specified a floppy image for drive A: (on command line or in config
36: file) which contains a desktop.inf/newdesk.inf/emutos.inf file on
37: it.
38: .PP
39: Booting will be done from the disk image or directory that's given
40: last on the command line as an option or the argument (and which
41: corresponds to A: or C:).
1.1 root 42: .SH "OPTIONS"
1.1.1.4 root 43: Hatari options are split into several categories:
44: .SH "General options"
1.1 root 45: .TP
46: .B \-h, \-\-help
1.1.1.4 root 47: Print command line options and terminate
1.1 root 48: .TP
49: .B \-v, \-\-version
1.1.1.4 root 50: Print version information and terminate
51: .TP
1.1.1.5 root 52: .B \-\-confirm-quit <bool>
1.1.1.4 root 53: Whether Hatari confirms quitting
54: .TP
55: .B \-c, \-\-configfile <filename>
1.1.1.5 root 56: use the given file as configuration file instead of ~/.hatari/hatari.cfg
1.1.1.9 root 57: .TP
58: .B \-k, \-\-keymap <file>
59: load keyboard mapping from <file>
1.1.1.5 root 60: .TP
61: .B \-\-fast-forward <bool>
62: On fast machine helps skipping (fast forwarding) Hatari output
1.1.1.9 root 63: .SH "Common display options"
1.1 root 64: .TP
65: .B \-m, \-\-mono
1.1.1.4 root 66: Start in monochrome mode instead of color
67: .TP
68: .B \-\-monitor <x>
69: Select monitor type (x = mono/rgb/vga/tv)
1.1 root 70: .TP
71: .B \-f, \-\-fullscreen
1.1.1.4 root 72: Start the emulator in fullscreen mode
1.1.1.2 root 73: .TP
74: .B \-w, \-\-window
1.1.1.4 root 75: Start the emulator in window mode
1.1 root 76: .TP
1.1.1.7 root 77: .B \-\-grab
78: Grab mouse (also) in window mode
79: .TP
1.1.1.4 root 80: .B \-\-frameskips <x>
81: Skip <x> frames after each displayed frame to accelerate emulation
1.1.1.5 root 82: (0=disabled, >4 uses automatic frameskip with given value as maximum)
1.1 root 83: .TP
1.1.1.5 root 84: .B \-\-statusbar <bool>
85: Show statusbar (with floppy leds etc etc)
86: .TP
87: .B \-\-drive-led <bool>
88: Show overlay drive led when statusbar isn't shown
1.1.1.4 root 89: .TP
1.1.1.9 root 90: .B \-\-bpp <bool>
91: Force internal bitdepth (x = 8/15/16/32, 0=disable)
92: .SH "ST/STE specific display options"
93: .TP
94: .B \-\-borders <bool>
95: Show ST/STE screen borders (for low/med resolution overscan demos)
96: .TP
1.1.1.10 root 97: .B \-\-desktop-st <bool>
98: Whether fullscreen mode uses desktop resolution to avoid: messing
99: multi-screen setups, several seconds delay needed by LCD monitors
100: resolution switching and the resulting sound break. As Hatari ST/E
101: display code doesn't support zooming (except low-rez doubling), it
102: doesn't get scaled (by Hatari or monitor) when this is enabled.
103: Therefore this is mainly useful only if you suffer from the described
104: effects, but still want to grab mouse and remove other distractions
105: from the screen just by toggling fullscreen mode. (disabled by default)
106: .TP
1.1.1.4 root 107: .B \-\-spec512 <x>
108: Hatari uses this threshold to decide when to render a screen with
109: the slower but more accurate Spectrum512 screen conversion functions
110: (0 <= x <= 512, 0=disable)
1.1.1.9 root 111: .TP
112: .B \-z, \-\-zoom <x>
113: Zoom (double) low resolution (1=no, 2=yes)
114: .SH "Falcon/TT specific display options"
115: Zooming to sizes specified below is internally done using integer scaling
116: factors. This means that different Atari resolutions may show up with
117: different sizes, but they are never blurry.
118: .TP
119: .B \-\-desktop <bool>
120: Whether to use desktop resolution on fullscreen to avoid issues
121: related to resolution switching. Otherwise fullscreen will use
1.1.1.10 root 122: a resolution that is closest to the Hatari window size.
123: (enabled by default)
1.1.1.4 root 124: .TP
1.1.1.9 root 125: .B \-\-max-width <x>
126: Preferred / maximum window width
1.1.1.10 root 127: .TP
1.1.1.9 root 128: .B \-\-max-height <x>
129: Preferred / maximum window height
1.1.1.10 root 130: .TP
131: .B \-\-force-max <bool>
132: Hatari window size is forced to specified maximum size and black borders
133: used when Atari resolution doesn't scale evenly to it. This is most
134: useful when recording videos of Falcon demos that change their
135: resolution. (disabled by default)
136: .TP
1.1.1.9 root 137: .B \-\-aspect <bool>
138: Whether to do monitor aspect ratio correction (enabled by default)
1.1.1.4 root 139: .SH "VDI options"
1.1.1.10 root 140: .TP
1.1.1.5 root 141: .B \-\-vdi <bool>
142: Whether to use VDI screen mode
1.1.1.10 root 143: .TP
1.1.1.4 root 144: .B \-\-vdi\-planes <x>
145: Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
1.1.1.10 root 146: .TP
1.1.1.4 root 147: .B \-\-vdi\-width <w>
1.1.1.8 root 148: Use extended VDI resolution with width <w> (320 < w <= 1280)
1.1.1.10 root 149: .TP
1.1.1.4 root 150: .B \-\-vdi\-height <h>
1.1.1.8 root 151: Use extended VDI resolution with height <h> (200 < h <= 960)
1.1.1.9 root 152: .SH "Screen capture options"
153: .TP
154: .B \-\-crop <bool>
155: Remove statusbar from the screen captures
1.1.1.8 root 156: .TP
157: .B \-\-avirecord
158: Start AVI recording
159: .TP
160: .B \-\-avi-vcodec <x>
161: Select avi video codec (x = bmp/png)
162: .TP
163: .B \-\-avi-fps <x>
164: Force avi frame rate (x = 50/60/71/...)
165: .TP
166: .B \-\-avi-file <file>
167: Use <file> to record avi
1.1.1.4 root 168: .SH "Devices options"
1.1 root 169: .TP
1.1.1.4 root 170: .B \-j, \-\-joystick <port>
171: Emulate joystick with cursor keys in given port (0-5)
1.1 root 172: .TP
1.1.1.5 root 173: .B \-\-joy<port> <type>
174: Set joystick type (none/keys/real) for given port
175: .TP
1.1.1.4 root 176: .B \-\-printer <file>
177: Enable printer support and write data to <file>
1.1.1.2 root 178: .TP
1.1.1.6 root 179: .B \-\-midi-in <filename>
180: Enable MIDI support and write MIDI data to <file>
1.1 root 181: .TP
1.1.1.6 root 182: .B \-\-midi-out <filename>
183: Enable MIDI support and read MIDI data from <file>
184: .TP
185: .B \-\-rs232-in <filename>
186: Enable serial port support and use <file> as the input device
187: .TP
188: .B \-\-rs232-out <filename>
189: Enable serial port support and use <file> as the output device
1.1.1.4 root 190: .SH "Disk options"
1.1.1.5 root 191: .TP
192: .B \-\-disk-a <file>
193: Set disk image for floppy drive A
194: .TP
195: .B \-\-disk-b <file>
196: Set disk image for floppy drive B
1.1.1.8 root 197: .TP
198: .B \-\-protect-floppy <x>
199: Write protect floppy image contents (on/off/auto). With "auto" option
200: write protection is according to the disk image file attributes.
201: .TP
202: .B \-\-protect-hd <x>
203: Write protect harddrive <dir> contents (on/off/auto). With "auto" option
204: the protection can be controlled by setting individual files attributes
205: as it disables the file attribute modifications for the GEMDOS hard disk
206: emulation.
1.1 root 207: .TP
1.1.1.4 root 208: .B \-d, \-\-harddrive <dir>
1.1.1.10 root 209: Emulate harddrive partition(s) with <dir> contents. If directory
210: contains only single letter (C-Z) subdirectories, each of these
211: subdirectories will be treated as a separate partition, otherwise the
212: given directory itself will be assigned to drive "C:". In the multiple
213: partition case, the letters used as the subdirectory names will
214: determine to which drives/partitions they're assigned.
215: .TP
1.1.1.4 root 216: .B \-\-acsi <file>
1.1.1.5 root 217: Emulate an ACSI hard disk with an image <file>
218: .TP
1.1.1.8 root 219: .B \-\-ide\-master <file>
220: Emulate an IDE master hard disk with an image <file>
221: .TP
222: .B \-\-ide\-slave <file>
223: Emulate an IDE slave hard disk with an image <file>
1.1 root 224: .TP
1.1.1.10 root 225: .B \-\-fastfdc <bool>
226: speed up FDC emulation (can cause incompatibilities)
1.1.1.4 root 227: .SH "Memory options"
1.1 root 228: .TP
1.1.1.10 root 229: .B \-\-memstate <file>
230: Load memory snap-shot <file>
231: .TP
1.1.1.4 root 232: .B \-s, \-\-memsize <x>
233: Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 KiB
1.1.1.10 root 234: .SH "ROM options"
1.1 root 235: .TP
1.1.1.4 root 236: .B \-t, \-\-tos <imagefile>
237: Specify TOS ROM image to use
1.1 root 238: .TP
1.1.1.10 root 239: .B \-\-patch-tos <bool>
240: Use this option to enable/disable TOS ROM patching. Experts only! Leave
241: this enabled unless you know what you are doing!
242: .TP
1.1.1.4 root 243: .B \-\-cartridge <imagefile>
244: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
245: extended VDI resolution are disabled)
246: .SH "CPU options"
247: .TP
248: .B \-\-cpulevel <x>
249: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
250: .TP
251: .B \-\-cpuclock <x>
252: Set the CPU clock (8, 16 or 32 Mhz)
253: .TP
254: .B \-\-compatible <bool>
1.1.1.9 root 255: Use a more compatible, but slower 68000 CPU mode with
256: better prefetch accuracy and cycle counting
1.1.1.4 root 257: .SH "Misc system options"
1.1.1.3 root 258: .TP
259: .B \-\-machine <x>
1.1.1.9 root 260: Select machine type (x = st, ste, tt or falcon)
1.1.1.4 root 261: .TP
262: .B \-\-blitter <bool>
1.1.1.5 root 263: Enable blitter emulation (ST only)
1.1.1.4 root 264: .TP
265: .B \-\-dsp <x>
1.1.1.5 root 266: Falcon DSP emulation (x = none, dummy or emu, Falcon only)
1.1.1.4 root 267: .TP
1.1.1.10 root 268: .B \-\-timer-d <bool>
269: Patch redundantly high Timer-D frequency set by TOS. This about doubles
270: Hatari speed (for ST/e emulation) as the original Timer-D frequency causes
271: most of the interrupts.
272: .TP
273: .B \-\-fast-boot <bool>
274: Patch TOS and initialize the so-called "memvalid" system variables to by-pass
275: the memory test of TOS, so that the system boots faster.
276: .TP
277: .B \-\-rtc <bool>
278: Enable real-time clock
279: .SH "Sound options"
280: .TP
1.1.1.9 root 281: .B \-\-mic <bool>
282: Enable/disable (Falcon only) microphone
283: .TP
1.1.1.4 root 284: .B \-\-sound <x>
1.1.1.7 root 285: Sound frequency: 6000-50066. "off" disables the sound and speeds up
286: the emulation. To prevent extra sound artifacts, the frequency should be
287: selected so that it either matches evenly with the STE/TT/Falcon sound
288: DMA (6258, 12517, 250033, 50066 Hz) or your sound card frequencies
289: (11025, 22050, 44100 or 6000...48000 Hz). Check what your sound card
290: supports.
1.1.1.8 root 291: .TP
292: .B \-\-sound-buffer-size <x>
1.1.1.9 root 293: SDL's sound buffer size: 10-100, or 0 to use default buffer size.
1.1.1.8 root 294: By default Hatari uses an SDL buffer size of 1024 samples, which
295: gives approximatively 20-30 ms of sound depending on the chosen sound
296: frequency. Under some OS or with not fully supported sound card, this
297: default setting can cause a bigger delay at lower frequency (nearly 0.5 sec).
298: In that case, you can use this option to force the size of the sound
299: buffer to a fixed number of milliseconds of sound (using 20 is often
300: a good choice if you have such problems). Most users will not need this option.
1.1.1.9 root 301: .TP
1.1.1.11! root 302: .B \-\-sound-sync <bool>
! 303: The emulation rate is nudged by +100 or 0 or -100 micro-seconds on occasion.
! 304: This prevents the sound buffer from overflowing (long latency and
! 305: lost samples) or underflowing (short latency and repeated samples).
! 306: The emulation rate smoothly deviates by a maximum of 0.58% until
! 307: synchronized, while the emulator continuously generates every sound
! 308: sample and the crystal controlled sound system consumes every sample.
! 309: .br
! 310: (on|off, off=default)
! 311: .TP
1.1.1.9 root 312: .B \-\-ym-mixing <x>
313: Select a method for mixing the three YM2149 voice volumes together.
1.1.1.10 root 314: "model" uses a mathematical model of the YM voices,
1.1.1.9 root 315: "table" uses a lookup table of audio output voltage values measured
316: on STF and "linear" just averages the 3 YM voices.
1.1.1.4 root 317: .SH "Debug options"
318: .TP
1.1.1.7 root 319: .B \-D, \-\-debug
320: Toggle whether CPU exceptions invoke the debugger
1.1.1.5 root 321: .TP
322: .B \-\-bios-intercept
1.1.1.9 root 323: Toggle Bios/XBios call interception and BIOS CON: output
324: (e.g. EmuTOS console) redirection to host terminal.
325: Needed for Bios/XBios call tracing. Allows Atari programs
326: to modify Hatari state through XBios 255 calls.
1.1.1.4 root 327: .TP
328: .B \-\-trace <trace1,...>
1.1.1.5 root 329: Activate debug traces, see
330: .B \-\-trace help
331: for available tracing options
332: .TP
1.1.1.8 root 333: .B \-\-trace-file <file>
334: Save trace output to <file> (default=stderr)
335: .TP
336: .B \-\-parse <file>
337: Parse/execute debugger commands from <file>
338: .TP
339: .B \-\-saveconfig
340: Save Hatari configuration and exit. Hatari UI needs Hatari configuration
341: file to start, this can be used to create it automatically.
342: .TP
343: .B \-\-no-parachute
344: Disable SDL parachute to get Hatari core dumps. SDL parachute is enabled
345: by default to restore video mode in case Hatari terminates abnormally
346: while using non-standard screen resolution.
347: .TP
1.1.1.5 root 348: .B \-\-control-socket <file>
349: Hatari reads options from given socket at run-time
350: .TP
351: .B \-\-log-file <file>
352: Save log output to <file> (default=stderr)
353: .TP
354: .B \-\-log-level <x>
355: Log output level (x=debug/todo/info/warn/error/fatal)
356: .TP
357: .B \-\-alert-level <x>
358: Show dialog for log messages above given level
1.1.1.7 root 359: .TP
360: .B \-\-run-vbls <x>
361: Exit after X VBLs
1.1 root 362: .SH "COMMANDS"
1.1.1.3 root 363: The shortcut keys can be configured in the configuration file.
364: The default settings are:
1.1 root 365: .TP
366: .B AltGr + a
367: record animation
368: .TP
369: .B AltGr + g
370: grab a screenshot
371: .TP
372: .B AltGr + i
373: boss key: leave full screen mode and iconify window
374: .TP
375: .B AltGr + j
376: activate joystick emulation via cursor keys
377: .TP
378: .B AltGr + m
379: (un-)lock the mouse into the window
380: .TP
381: .B AltGr + r
1.1.1.5 root 382: warm reset the ST (same as the reset button)
1.1 root 383: .TP
384: .B AltGr + c
1.1.1.5 root 385: cold reset the ST (same as the power switch)
386: .TP
387: .B AltGr + d
388: open dialog to select/change disk A
1.1 root 389: .TP
390: .B AltGr + s
391: enable/disable sound
392: .TP
393: .B AltGr + q
394: quit the emulator
395: .TP
396: .B AltGr + x
397: toggle normal/max speed
398: .TP
399: .B AltGr + y
400: enable/disable sound recording
401: .TP
1.1.1.4 root 402: .B AltGr + k
403: save memory snapshot
404: .TP
405: .B AltGr + l
406: load memory snapshot
407: .TP
1.1 root 408: .B F11
409: toggle between fullscreen and windowed mode
410: .TP
411: .B F12
1.1.1.5 root 412: activate the hatari options GUI
1.1 root 413: .br
414: You may need to hold SHIFT down while in windowed mode.
415: .TP
416: .B Pause
1.1.1.7 root 417: Pauses the emulation
418: .TP
419: .B AltGr + Pause
420: Invokes the internal Hatari debugger
1.1 root 421:
422: .SH Emulated Atari ST keyboard
1.1.1.3 root 423: All other keys on the keyboard act as the normal Atari ST keys so
424: pressing SPACE on your PC will result in an emulated press of the
425: SPACE key on the ST. The following keys have special meanings:
1.1 root 426: .TP
427: .B Alt
428: will act as the ST's ALTERNATE key
429: .TP
430: .B left Ctrl
431: will act as the ST's CONTROL key
432: .TP
433: .B Page Up
434: will emulate the ST's HELP key
435: .TP
436: .B Page Down
437: will emulate the ST's UNDO key
438: .PP
439: .B AltGr
440: will act as
441: .B Alternate
1.1.1.3 root 442: as well as long as you do not press it together with a Hatari hotkey
443: combination.
1.1 root 444:
445: The
446: .B right Ctrl
1.1.1.3 root 447: key is used as the fire button of the emulated joystick when you turn
448: on joystick emulation via keyboard.
1.1 root 449:
1.1.1.3 root 450: The cursor keys will act as the cursor keys on the Atari ST as long as
451: joystick emulation via keyboard has been turned off.
1.1 root 452:
453: .SH "SEE ALSO"
454: The main program documentation, usually in /usr/share/doc/.
1.1.1.9 root 455: Among other things it contains an extensive usage manual,
456: software compatiblity list and release notes.
1.1 root 457: .PP
1.1.1.10 root 458: The homepage of hatari: http://hatari.tuxfamily.org/
1.1.1.9 root 459: .PP
460: Other Hatari programs and utilities:
461: .br
462: .IR hmsa (1),
463: .IR zip2st (1),
464: .IR atari-hd-image (1),
465: .IR hatariui (1),
466: .IR hconsole (1)
1.1.1.5 root 467: .SH "FILES AND DIRECTORIES"
1.1.1.3 root 468: .TP
469: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
1.1.1.5 root 470: The global configuration file of Hatari.
471: .TP
472: ~/.hatari/
473: The (default) directory for user's personal Hatari files;
474: .B hatari.cfg
475: (configuration file),
476: .B hatari.nvram
477: (NVRAM content file),
478: .B hatari.sav
479: (Hatari memory state snapshot file which Hatari can load/save automatically
480: when it starts/exits),
481: .B hatari.prn
482: (printer output file),
483: .B hatari.wav
484: (recorded sound output in WAV format),
485: .B hatari.ym
486: (recorded sound output in YM format).
1.1.1.3 root 487: .TP
1.1.1.5 root 488: /usr/share/hatari/ (or /usr/local/share/hatari/)
489: The global data directory of Hatari.
1.1.1.3 root 490: .TP
491: tos.img
492: The TOS ROM image will be loaded from the data directory of Hatari unless it
493: is specified on the command line or the configuration file.
494:
1.1 root 495: .SH "AUTHOR"
1.1.1.5 root 496: This manual page was written by Marco Herrn <[email protected]> for the
497: Debian project and later modified by Thomas Huth and Eero Tamminen to
498: suit the latest version of Hatari.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.