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