![[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.8 ! root 5: .TH "HATARI" "1" "2010-05-02" "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]
13: .RI [diskimage]
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
24: fully compatible with the original TOS some programs won't run
25: correctly with this. Because of this it is recommended to use a TOS
26: ROM from a real Atari.
1.1 root 27: .SH "OPTIONS"
1.1.1.4 root 28: Hatari options are split into several categories:
29: .SH "General options"
1.1 root 30: .TP
31: .B \-h, \-\-help
1.1.1.4 root 32: Print command line options and terminate
1.1 root 33: .TP
34: .B \-v, \-\-version
1.1.1.4 root 35: Print version information and terminate
36: .TP
1.1.1.5 root 37: .B \-\-confirm-quit <bool>
1.1.1.4 root 38: Whether Hatari confirms quitting
39: .TP
40: .B \-c, \-\-configfile <filename>
1.1.1.5 root 41: use the given file as configuration file instead of ~/.hatari/hatari.cfg
42: .TP
43: .B \-\-fast-forward <bool>
44: On fast machine helps skipping (fast forwarding) Hatari output
1.1.1.4 root 45: .SH "Display options"
1.1 root 46: .TP
47: .B \-m, \-\-mono
1.1.1.4 root 48: Start in monochrome mode instead of color
49: .TP
50: .B \-\-monitor <x>
51: Select monitor type (x = mono/rgb/vga/tv)
1.1 root 52: .TP
53: .B \-f, \-\-fullscreen
1.1.1.4 root 54: Start the emulator in fullscreen mode
1.1.1.2 root 55: .TP
56: .B \-w, \-\-window
1.1.1.4 root 57: Start the emulator in window mode
1.1 root 58: .TP
1.1.1.7 root 59: .B \-\-grab
60: Grab mouse (also) in window mode
61: .TP
1.1.1.4 root 62: .B \-z, \-\-zoom <x>
63: Zoom low resolution (1=no, 2=yes)
1.1 root 64: .TP
1.1.1.8 ! root 65: .B \-\-max-width <x>
! 66: Maximum window width for zooming (Falcon/TT only)
! 67: .TP
! 68: .B \-\-max-height <x>
! 69: Maximum window height for zooming (Falcon/TT only)
! 70: .TP
! 71: .B \-\-aspect <bool>
! 72: Whether to do monitor aspect ratio correction (Falcon/TT only)
! 73: .TP
! 74: .B \-\-borders <bool>
! 75: Show ST/STE screen borders (for low/med resolution overscan demos)
! 76: .TP
1.1.1.4 root 77: .B \-\-frameskips <x>
78: Skip <x> frames after each displayed frame to accelerate emulation
1.1.1.5 root 79: (0=disabled, >4 uses automatic frameskip with given value as maximum)
1.1 root 80: .TP
1.1.1.5 root 81: .B \-\-statusbar <bool>
82: Show statusbar (with floppy leds etc etc)
83: .TP
84: .B \-\-drive-led <bool>
85: Show overlay drive led when statusbar isn't shown
1.1.1.4 root 86: .TP
87: .B \-\-spec512 <x>
88: Hatari uses this threshold to decide when to render a screen with
89: the slower but more accurate Spectrum512 screen conversion functions
90: (0 <= x <= 512, 0=disable)
91: .TP
92: .B \-\-bpp <bool>
1.1.1.5 root 93: Force internal bitdepth (x = 8/15/16/32, 0=disable)
1.1.1.4 root 94: .SH "VDI options"
1.1 root 95: .TP
1.1.1.5 root 96: .B \-\-vdi <bool>
97: Whether to use VDI screen mode
98: .TP
1.1.1.4 root 99: .B \-\-vdi\-planes <x>
100: Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
1.1 root 101: .TP
1.1.1.4 root 102: .B \-\-vdi\-width <w>
1.1.1.8 ! root 103: Use extended VDI resolution with width <w> (320 < w <= 1280)
1.1 root 104: .TP
1.1.1.4 root 105: .B \-\-vdi\-height <h>
1.1.1.8 ! root 106: Use extended VDI resolution with height <h> (200 < h <= 960)
! 107: .SH "Video recording options"
! 108: .TP
! 109: .B \-\-avirecord
! 110: Start AVI recording
! 111: .TP
! 112: .B \-\-avi-vcodec <x>
! 113: Select avi video codec (x = bmp/png)
! 114: .TP
! 115: .B \-\-avi-fps <x>
! 116: Force avi frame rate (x = 50/60/71/...)
! 117: .TP
! 118: .B \-\-avi-crop <bool>
! 119: Remove status bar from the recorded file
! 120: .TP
! 121: .B \-\-avi-file <file>
! 122: Use <file> to record avi
1.1.1.4 root 123: .SH "Devices options"
1.1 root 124: .TP
1.1.1.4 root 125: .B \-j, \-\-joystick <port>
126: Emulate joystick with cursor keys in given port (0-5)
1.1 root 127: .TP
1.1.1.5 root 128: .B \-\-joy<port> <type>
129: Set joystick type (none/keys/real) for given port
130: .TP
1.1.1.4 root 131: .B \-\-printer <file>
132: Enable printer support and write data to <file>
1.1.1.2 root 133: .TP
1.1.1.6 root 134: .B \-\-midi-in <filename>
135: Enable MIDI support and write MIDI data to <file>
1.1 root 136: .TP
1.1.1.6 root 137: .B \-\-midi-out <filename>
138: Enable MIDI support and read MIDI data from <file>
139: .TP
140: .B \-\-rs232-in <filename>
141: Enable serial port support and use <file> as the input device
142: .TP
143: .B \-\-rs232-out <filename>
144: Enable serial port support and use <file> as the output device
1.1.1.4 root 145: .SH "Disk options"
1.1.1.5 root 146: .TP
147: .B \-\-disk-a <file>
148: Set disk image for floppy drive A
149: .TP
150: .B \-\-disk-b <file>
151: Set disk image for floppy drive B
1.1.1.8 ! root 152: .TP
! 153: .B \-\-protect-floppy <x>
! 154: Write protect floppy image contents (on/off/auto). With "auto" option
! 155: write protection is according to the disk image file attributes.
! 156: .TP
! 157: .B \-\-protect-hd <x>
! 158: Write protect harddrive <dir> contents (on/off/auto). With "auto" option
! 159: the protection can be controlled by setting individual files attributes
! 160: as it disables the file attribute modifications for the GEMDOS hard disk
! 161: emulation.
1.1 root 162: .TP
1.1.1.4 root 163: .B \-d, \-\-harddrive <dir>
1.1.1.8 ! root 164: Emulate harddrive partition(s) with <dir> contents
1.1 root 165: .TP
1.1.1.4 root 166: .B \-\-acsi <file>
1.1.1.5 root 167: Emulate an ACSI hard disk with an image <file>
168: .TP
1.1.1.8 ! root 169: .B \-\-ide\-master <file>
! 170: Emulate an IDE master hard disk with an image <file>
! 171: .TP
! 172: .B \-\-ide\-slave <file>
! 173: Emulate an IDE slave hard disk with an image <file>
1.1 root 174: .TP
1.1.1.4 root 175: .B \-\-slowfdc <bool>
1.1.1.5 root 176: slow down FDC emulation (deprecated)
1.1.1.4 root 177: .SH "Memory options"
1.1 root 178: .TP
1.1.1.4 root 179: .B \-s, \-\-memsize <x>
180: Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 KiB
1.1 root 181: .TP
1.1.1.4 root 182: .B \-t, \-\-tos <imagefile>
183: Specify TOS ROM image to use
1.1 root 184: .TP
1.1.1.4 root 185: .B \-\-cartridge <imagefile>
186: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
187: extended VDI resolution are disabled)
1.1 root 188: .TP
1.1.1.4 root 189: .B \-\-memstate <file>
190: Load memory snap-shot <file>
191: .SH "CPU options"
192: .TP
193: .B \-\-cpulevel <x>
194: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
195: .TP
196: .B \-\-cpuclock <x>
197: Set the CPU clock (8, 16 or 32 Mhz)
198: .TP
199: .B \-\-compatible <bool>
200: Use a more compatible but slower 68000 CPU mode
201: .SH "Misc system options"
1.1.1.3 root 202: .TP
203: .B \-\-machine <x>
1.1.1.4 root 204: select machine type (x = st, ste, tt or falcon)
205: .TP
206: .B \-\-blitter <bool>
1.1.1.5 root 207: Enable blitter emulation (ST only)
1.1.1.4 root 208: .TP
1.1.1.7 root 209: .B \-\-timer-d <bool>
210: Patch redundantly high Timer-D frequency set by TOS. This about doubles
211: Hatari speed as the original Timer-D frequency causes most of the interrupts.
212: .TP
1.1.1.4 root 213: .B \-\-dsp <x>
1.1.1.5 root 214: Falcon DSP emulation (x = none, dummy or emu, Falcon only)
1.1.1.4 root 215: .TP
216: .B \-\-sound <x>
1.1.1.7 root 217: Sound frequency: 6000-50066. "off" disables the sound and speeds up
218: the emulation. To prevent extra sound artifacts, the frequency should be
219: selected so that it either matches evenly with the STE/TT/Falcon sound
220: DMA (6258, 12517, 250033, 50066 Hz) or your sound card frequencies
221: (11025, 22050, 44100 or 6000...48000 Hz). Check what your sound card
222: supports.
1.1.1.8 ! root 223: .TP
! 224: .B \-\-sound-buffer-size <x>
! 225: SDL's sound buffer size : 10-100, or 0 to use default buffer size.
! 226: By default Hatari uses an SDL buffer size of 1024 samples, which
! 227: gives approximatively 20-30 ms of sound depending on the chosen sound
! 228: frequency. Under some OS or with not fully supported sound card, this
! 229: default setting can cause a bigger delay at lower frequency (nearly 0.5 sec).
! 230: In that case, you can use this option to force the size of the sound
! 231: buffer to a fixed number of milliseconds of sound (using 20 is often
! 232: a good choice if you have such problems). Most users will not need this option.
1.1.1.7 root 233: .TP
1.1.1.5 root 234: .B \-k, \-\-keymap <file>
1.1.1.3 root 235: load keyboard mapping from <file>
1.1.1.4 root 236: .SH "Debug options"
237: .TP
1.1.1.7 root 238: .B \-D, \-\-debug
239: Toggle whether CPU exceptions invoke the debugger
1.1.1.5 root 240: .TP
241: .B \-\-bios-intercept
242: Enable Bios/XBios interception
1.1.1.4 root 243: .TP
244: .B \-\-trace <trace1,...>
1.1.1.5 root 245: Activate debug traces, see
246: .B \-\-trace help
247: for available tracing options
248: .TP
1.1.1.8 ! root 249: .B \-\-trace-file <file>
! 250: Save trace output to <file> (default=stderr)
! 251: .TP
! 252: .B \-\-parse <file>
! 253: Parse/execute debugger commands from <file>
! 254: .TP
! 255: .B \-\-saveconfig
! 256: Save Hatari configuration and exit. Hatari UI needs Hatari configuration
! 257: file to start, this can be used to create it automatically.
! 258: .TP
! 259: .B \-\-no-parachute
! 260: Disable SDL parachute to get Hatari core dumps. SDL parachute is enabled
! 261: by default to restore video mode in case Hatari terminates abnormally
! 262: while using non-standard screen resolution.
! 263: .TP
1.1.1.5 root 264: .B \-\-control-socket <file>
265: Hatari reads options from given socket at run-time
266: .TP
267: .B \-\-log-file <file>
268: Save log output to <file> (default=stderr)
269: .TP
270: .B \-\-log-level <x>
271: Log output level (x=debug/todo/info/warn/error/fatal)
272: .TP
273: .B \-\-alert-level <x>
274: Show dialog for log messages above given level
1.1.1.7 root 275: .TP
276: .B \-\-run-vbls <x>
277: Exit after X VBLs
1.1 root 278: .SH "COMMANDS"
1.1.1.3 root 279: The shortcut keys can be configured in the configuration file.
280: The default settings are:
1.1 root 281: .TP
282: .B AltGr + a
283: record animation
284: .TP
285: .B AltGr + g
286: grab a screenshot
287: .TP
288: .B AltGr + i
289: boss key: leave full screen mode and iconify window
290: .TP
291: .B AltGr + j
292: activate joystick emulation via cursor keys
293: .TP
294: .B AltGr + m
295: (un-)lock the mouse into the window
296: .TP
297: .B AltGr + r
1.1.1.5 root 298: warm reset the ST (same as the reset button)
1.1 root 299: .TP
300: .B AltGr + c
1.1.1.5 root 301: cold reset the ST (same as the power switch)
302: .TP
303: .B AltGr + d
304: open dialog to select/change disk A
1.1 root 305: .TP
306: .B AltGr + s
307: enable/disable sound
308: .TP
309: .B AltGr + q
310: quit the emulator
311: .TP
312: .B AltGr + x
313: toggle normal/max speed
314: .TP
315: .B AltGr + y
316: enable/disable sound recording
317: .TP
1.1.1.4 root 318: .B AltGr + k
319: save memory snapshot
320: .TP
321: .B AltGr + l
322: load memory snapshot
323: .TP
1.1 root 324: .B F11
325: toggle between fullscreen and windowed mode
326: .TP
327: .B F12
1.1.1.5 root 328: activate the hatari options GUI
1.1 root 329: .br
330: You may need to hold SHIFT down while in windowed mode.
331: .TP
332: .B Pause
1.1.1.7 root 333: Pauses the emulation
334: .TP
335: .B AltGr + Pause
336: Invokes the internal Hatari debugger
1.1 root 337:
338: .SH Emulated Atari ST keyboard
1.1.1.3 root 339: All other keys on the keyboard act as the normal Atari ST keys so
340: pressing SPACE on your PC will result in an emulated press of the
341: SPACE key on the ST. The following keys have special meanings:
1.1 root 342: .TP
343: .B Alt
344: will act as the ST's ALTERNATE key
345: .TP
346: .B left Ctrl
347: will act as the ST's CONTROL key
348: .TP
349: .B Page Up
350: will emulate the ST's HELP key
351: .TP
352: .B Page Down
353: will emulate the ST's UNDO key
354: .PP
355: .B AltGr
356: will act as
357: .B Alternate
1.1.1.3 root 358: as well as long as you do not press it together with a Hatari hotkey
359: combination.
1.1 root 360:
361: The
362: .B right Ctrl
1.1.1.3 root 363: key is used as the fire button of the emulated joystick when you turn
364: on joystick emulation via keyboard.
1.1 root 365:
1.1.1.3 root 366: The cursor keys will act as the cursor keys on the Atari ST as long as
367: joystick emulation via keyboard has been turned off.
1.1 root 368:
369: .SH "SEE ALSO"
370: The main program documentation, usually in /usr/share/doc/.
371: .PP
1.1.1.6 root 372: The homepage of hatari: http://hatari.berlios.de/
1.1 root 373:
1.1.1.5 root 374: .SH "FILES AND DIRECTORIES"
1.1.1.3 root 375: .TP
376: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
1.1.1.5 root 377: The global configuration file of Hatari.
378: .TP
379: ~/.hatari/
380: The (default) directory for user's personal Hatari files;
381: .B hatari.cfg
382: (configuration file),
383: .B hatari.nvram
384: (NVRAM content file),
385: .B hatari.sav
386: (Hatari memory state snapshot file which Hatari can load/save automatically
387: when it starts/exits),
388: .B hatari.prn
389: (printer output file),
390: .B hatari.wav
391: (recorded sound output in WAV format),
392: .B hatari.ym
393: (recorded sound output in YM format).
1.1.1.3 root 394: .TP
1.1.1.5 root 395: /usr/share/hatari/ (or /usr/local/share/hatari/)
396: The global data directory of Hatari.
1.1.1.3 root 397: .TP
398: tos.img
399: The TOS ROM image will be loaded from the data directory of Hatari unless it
400: is specified on the command line or the configuration file.
401:
1.1 root 402: .SH "AUTHOR"
1.1.1.5 root 403: This manual page was written by Marco Herrn <[email protected]> for the
404: Debian project and later modified by Thomas Huth and Eero Tamminen to
405: 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.