![[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.9 ! root 5: .TH "HATARI" "1" "2011-05-09" "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.4 root 97: .B \-\-spec512 <x>
98: Hatari uses this threshold to decide when to render a screen with
99: the slower but more accurate Spectrum512 screen conversion functions
100: (0 <= x <= 512, 0=disable)
1.1.1.9 ! root 101: .TP
! 102: .B \-z, \-\-zoom <x>
! 103: Zoom (double) low resolution (1=no, 2=yes)
! 104: .SH "Falcon/TT specific display options"
! 105: Zooming to sizes specified below is internally done using integer scaling
! 106: factors. This means that different Atari resolutions may show up with
! 107: different sizes, but they are never blurry.
! 108: .TP
! 109: .B \-\-desktop <bool>
! 110: Whether to use desktop resolution on fullscreen to avoid issues
! 111: related to resolution switching. Otherwise fullscreen will use
! 112: a resolution that is closest to the Hatari window size
1.1.1.4 root 113: .TP
1.1.1.9 ! root 114: .B \-\-max-width <x>
! 115: Preferred / maximum window width
! 116: .TP
! 117: .B \-\-max-height <x>
! 118: Preferred / maximum window height
! 119: .TP
! 120: .B \-\-aspect <bool>
! 121: Whether to do monitor aspect ratio correction (enabled by default)
1.1.1.4 root 122: .SH "VDI options"
1.1 root 123: .TP
1.1.1.5 root 124: .B \-\-vdi <bool>
125: Whether to use VDI screen mode
126: .TP
1.1.1.4 root 127: .B \-\-vdi\-planes <x>
128: Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
1.1 root 129: .TP
1.1.1.4 root 130: .B \-\-vdi\-width <w>
1.1.1.8 root 131: Use extended VDI resolution with width <w> (320 < w <= 1280)
1.1 root 132: .TP
1.1.1.4 root 133: .B \-\-vdi\-height <h>
1.1.1.8 root 134: Use extended VDI resolution with height <h> (200 < h <= 960)
1.1.1.9 ! root 135: .SH "Screen capture options"
! 136: .TP
! 137: .B \-\-crop <bool>
! 138: Remove statusbar from the screen captures
1.1.1.8 root 139: .TP
140: .B \-\-avirecord
141: Start AVI recording
142: .TP
143: .B \-\-avi-vcodec <x>
144: Select avi video codec (x = bmp/png)
145: .TP
146: .B \-\-avi-fps <x>
147: Force avi frame rate (x = 50/60/71/...)
148: .TP
149: .B \-\-avi-file <file>
150: Use <file> to record avi
1.1.1.4 root 151: .SH "Devices options"
1.1 root 152: .TP
1.1.1.4 root 153: .B \-j, \-\-joystick <port>
154: Emulate joystick with cursor keys in given port (0-5)
1.1 root 155: .TP
1.1.1.5 root 156: .B \-\-joy<port> <type>
157: Set joystick type (none/keys/real) for given port
158: .TP
1.1.1.4 root 159: .B \-\-printer <file>
160: Enable printer support and write data to <file>
1.1.1.2 root 161: .TP
1.1.1.6 root 162: .B \-\-midi-in <filename>
163: Enable MIDI support and write MIDI data to <file>
1.1 root 164: .TP
1.1.1.6 root 165: .B \-\-midi-out <filename>
166: Enable MIDI support and read MIDI data from <file>
167: .TP
168: .B \-\-rs232-in <filename>
169: Enable serial port support and use <file> as the input device
170: .TP
171: .B \-\-rs232-out <filename>
172: Enable serial port support and use <file> as the output device
1.1.1.4 root 173: .SH "Disk options"
1.1.1.5 root 174: .TP
175: .B \-\-disk-a <file>
176: Set disk image for floppy drive A
177: .TP
178: .B \-\-disk-b <file>
179: Set disk image for floppy drive B
1.1.1.8 root 180: .TP
181: .B \-\-protect-floppy <x>
182: Write protect floppy image contents (on/off/auto). With "auto" option
183: write protection is according to the disk image file attributes.
184: .TP
185: .B \-\-protect-hd <x>
186: Write protect harddrive <dir> contents (on/off/auto). With "auto" option
187: the protection can be controlled by setting individual files attributes
188: as it disables the file attribute modifications for the GEMDOS hard disk
189: emulation.
1.1 root 190: .TP
1.1.1.4 root 191: .B \-d, \-\-harddrive <dir>
1.1.1.8 root 192: Emulate harddrive partition(s) with <dir> contents
1.1 root 193: .TP
1.1.1.4 root 194: .B \-\-acsi <file>
1.1.1.5 root 195: Emulate an ACSI hard disk with an image <file>
196: .TP
1.1.1.8 root 197: .B \-\-ide\-master <file>
198: Emulate an IDE master hard disk with an image <file>
199: .TP
200: .B \-\-ide\-slave <file>
201: Emulate an IDE slave hard disk with an image <file>
1.1 root 202: .TP
1.1.1.4 root 203: .B \-\-slowfdc <bool>
1.1.1.5 root 204: slow down FDC emulation (deprecated)
1.1.1.4 root 205: .SH "Memory options"
1.1 root 206: .TP
1.1.1.4 root 207: .B \-s, \-\-memsize <x>
208: Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 KiB
1.1 root 209: .TP
1.1.1.4 root 210: .B \-t, \-\-tos <imagefile>
211: Specify TOS ROM image to use
1.1 root 212: .TP
1.1.1.4 root 213: .B \-\-cartridge <imagefile>
214: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
215: extended VDI resolution are disabled)
1.1 root 216: .TP
1.1.1.4 root 217: .B \-\-memstate <file>
218: Load memory snap-shot <file>
219: .SH "CPU options"
220: .TP
221: .B \-\-cpulevel <x>
222: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
223: .TP
224: .B \-\-cpuclock <x>
225: Set the CPU clock (8, 16 or 32 Mhz)
226: .TP
227: .B \-\-compatible <bool>
1.1.1.9 ! root 228: Use a more compatible, but slower 68000 CPU mode with
! 229: better prefetch accuracy and cycle counting
1.1.1.4 root 230: .SH "Misc system options"
1.1.1.3 root 231: .TP
232: .B \-\-machine <x>
1.1.1.9 ! root 233: Select machine type (x = st, ste, tt or falcon)
1.1.1.4 root 234: .TP
235: .B \-\-blitter <bool>
1.1.1.5 root 236: Enable blitter emulation (ST only)
1.1.1.4 root 237: .TP
238: .B \-\-dsp <x>
1.1.1.5 root 239: Falcon DSP emulation (x = none, dummy or emu, Falcon only)
1.1.1.4 root 240: .TP
1.1.1.9 ! root 241: .B \-\-mic <bool>
! 242: Enable/disable (Falcon only) microphone
! 243: .TP
1.1.1.4 root 244: .B \-\-sound <x>
1.1.1.7 root 245: Sound frequency: 6000-50066. "off" disables the sound and speeds up
246: the emulation. To prevent extra sound artifacts, the frequency should be
247: selected so that it either matches evenly with the STE/TT/Falcon sound
248: DMA (6258, 12517, 250033, 50066 Hz) or your sound card frequencies
249: (11025, 22050, 44100 or 6000...48000 Hz). Check what your sound card
250: supports.
1.1.1.8 root 251: .TP
252: .B \-\-sound-buffer-size <x>
1.1.1.9 ! root 253: SDL's sound buffer size: 10-100, or 0 to use default buffer size.
1.1.1.8 root 254: By default Hatari uses an SDL buffer size of 1024 samples, which
255: gives approximatively 20-30 ms of sound depending on the chosen sound
256: frequency. Under some OS or with not fully supported sound card, this
257: default setting can cause a bigger delay at lower frequency (nearly 0.5 sec).
258: In that case, you can use this option to force the size of the sound
259: buffer to a fixed number of milliseconds of sound (using 20 is often
260: a good choice if you have such problems). Most users will not need this option.
1.1.1.9 ! root 261: .TP
! 262: .B \-\-ym-mixing <x>
! 263: Select a method for mixing the three YM2149 voice volumes together.
! 264: "table" uses a lookup table of audio output voltage values measured
! 265: on STF and "linear" just averages the 3 YM voices.
! 266: .TP
! 267: .B \-\-timer-d <bool>
! 268: Patch redundantly high Timer-D frequency set by TOS. This about doubles
! 269: Hatari speed (for ST/e emulation) as the original Timer-D frequency causes
! 270: most of the interrupts.
! 271: .TP
! 272: .B \-\-rtc <bool>
! 273: Enable real-time clock
1.1.1.4 root 274: .SH "Debug options"
275: .TP
1.1.1.7 root 276: .B \-D, \-\-debug
277: Toggle whether CPU exceptions invoke the debugger
1.1.1.5 root 278: .TP
279: .B \-\-bios-intercept
1.1.1.9 ! root 280: Toggle Bios/XBios call interception and BIOS CON: output
! 281: (e.g. EmuTOS console) redirection to host terminal.
! 282: Needed for Bios/XBios call tracing. Allows Atari programs
! 283: to modify Hatari state through XBios 255 calls.
1.1.1.4 root 284: .TP
285: .B \-\-trace <trace1,...>
1.1.1.5 root 286: Activate debug traces, see
287: .B \-\-trace help
288: for available tracing options
289: .TP
1.1.1.8 root 290: .B \-\-trace-file <file>
291: Save trace output to <file> (default=stderr)
292: .TP
293: .B \-\-parse <file>
294: Parse/execute debugger commands from <file>
295: .TP
296: .B \-\-saveconfig
297: Save Hatari configuration and exit. Hatari UI needs Hatari configuration
298: file to start, this can be used to create it automatically.
299: .TP
300: .B \-\-no-parachute
301: Disable SDL parachute to get Hatari core dumps. SDL parachute is enabled
302: by default to restore video mode in case Hatari terminates abnormally
303: while using non-standard screen resolution.
304: .TP
1.1.1.5 root 305: .B \-\-control-socket <file>
306: Hatari reads options from given socket at run-time
307: .TP
308: .B \-\-log-file <file>
309: Save log output to <file> (default=stderr)
310: .TP
311: .B \-\-log-level <x>
312: Log output level (x=debug/todo/info/warn/error/fatal)
313: .TP
314: .B \-\-alert-level <x>
315: Show dialog for log messages above given level
1.1.1.7 root 316: .TP
317: .B \-\-run-vbls <x>
318: Exit after X VBLs
1.1 root 319: .SH "COMMANDS"
1.1.1.3 root 320: The shortcut keys can be configured in the configuration file.
321: The default settings are:
1.1 root 322: .TP
323: .B AltGr + a
324: record animation
325: .TP
326: .B AltGr + g
327: grab a screenshot
328: .TP
329: .B AltGr + i
330: boss key: leave full screen mode and iconify window
331: .TP
332: .B AltGr + j
333: activate joystick emulation via cursor keys
334: .TP
335: .B AltGr + m
336: (un-)lock the mouse into the window
337: .TP
338: .B AltGr + r
1.1.1.5 root 339: warm reset the ST (same as the reset button)
1.1 root 340: .TP
341: .B AltGr + c
1.1.1.5 root 342: cold reset the ST (same as the power switch)
343: .TP
344: .B AltGr + d
345: open dialog to select/change disk A
1.1 root 346: .TP
347: .B AltGr + s
348: enable/disable sound
349: .TP
350: .B AltGr + q
351: quit the emulator
352: .TP
353: .B AltGr + x
354: toggle normal/max speed
355: .TP
356: .B AltGr + y
357: enable/disable sound recording
358: .TP
1.1.1.4 root 359: .B AltGr + k
360: save memory snapshot
361: .TP
362: .B AltGr + l
363: load memory snapshot
364: .TP
1.1 root 365: .B F11
366: toggle between fullscreen and windowed mode
367: .TP
368: .B F12
1.1.1.5 root 369: activate the hatari options GUI
1.1 root 370: .br
371: You may need to hold SHIFT down while in windowed mode.
372: .TP
373: .B Pause
1.1.1.7 root 374: Pauses the emulation
375: .TP
376: .B AltGr + Pause
377: Invokes the internal Hatari debugger
1.1 root 378:
379: .SH Emulated Atari ST keyboard
1.1.1.3 root 380: All other keys on the keyboard act as the normal Atari ST keys so
381: pressing SPACE on your PC will result in an emulated press of the
382: SPACE key on the ST. The following keys have special meanings:
1.1 root 383: .TP
384: .B Alt
385: will act as the ST's ALTERNATE key
386: .TP
387: .B left Ctrl
388: will act as the ST's CONTROL key
389: .TP
390: .B Page Up
391: will emulate the ST's HELP key
392: .TP
393: .B Page Down
394: will emulate the ST's UNDO key
395: .PP
396: .B AltGr
397: will act as
398: .B Alternate
1.1.1.3 root 399: as well as long as you do not press it together with a Hatari hotkey
400: combination.
1.1 root 401:
402: The
403: .B right Ctrl
1.1.1.3 root 404: key is used as the fire button of the emulated joystick when you turn
405: on joystick emulation via keyboard.
1.1 root 406:
1.1.1.3 root 407: The cursor keys will act as the cursor keys on the Atari ST as long as
408: joystick emulation via keyboard has been turned off.
1.1 root 409:
410: .SH "SEE ALSO"
411: The main program documentation, usually in /usr/share/doc/.
1.1.1.9 ! root 412: Among other things it contains an extensive usage manual,
! 413: software compatiblity list and release notes.
1.1 root 414: .PP
1.1.1.6 root 415: The homepage of hatari: http://hatari.berlios.de/
1.1.1.9 ! root 416: .PP
! 417: Other Hatari programs and utilities:
! 418: .br
! 419: .IR hmsa (1),
! 420: .IR zip2st (1),
! 421: .IR atari-hd-image (1),
! 422: .IR hatariui (1),
! 423: .IR hconsole (1)
1.1.1.5 root 424: .SH "FILES AND DIRECTORIES"
1.1.1.3 root 425: .TP
426: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
1.1.1.5 root 427: The global configuration file of Hatari.
428: .TP
429: ~/.hatari/
430: The (default) directory for user's personal Hatari files;
431: .B hatari.cfg
432: (configuration file),
433: .B hatari.nvram
434: (NVRAM content file),
435: .B hatari.sav
436: (Hatari memory state snapshot file which Hatari can load/save automatically
437: when it starts/exits),
438: .B hatari.prn
439: (printer output file),
440: .B hatari.wav
441: (recorded sound output in WAV format),
442: .B hatari.ym
443: (recorded sound output in YM format).
1.1.1.3 root 444: .TP
1.1.1.5 root 445: /usr/share/hatari/ (or /usr/local/share/hatari/)
446: The global data directory of Hatari.
1.1.1.3 root 447: .TP
448: tos.img
449: The TOS ROM image will be loaded from the data directory of Hatari unless it
450: is specified on the command line or the configuration file.
451:
1.1 root 452: .SH "AUTHOR"
1.1.1.5 root 453: This manual page was written by Marco Herrn <[email protected]> for the
454: Debian project and later modified by Thomas Huth and Eero Tamminen to
455: 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.