![[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.5 root 5: .TH "HATARI" "1" "2008-09-28" "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.5 root 19: ST or Atari STE. TT and Falcon support is experimental. Hatari supports
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.4 root 65: .B \-\-frameskips <x>
66: Skip <x> frames after each displayed frame to accelerate emulation
1.1.1.5 root 67: (0=disabled, >4 uses automatic frameskip with given value as maximum)
1.1 root 68: .TP
1.1.1.4 root 69: .B \-\-borders <bool>
1.1.1.5 root 70: Show screen borders (for overscan demos, ST(e) color mode specific etc)
71: .TP
72: .B \-\-statusbar <bool>
73: Show statusbar (with floppy leds etc etc)
74: .TP
75: .B \-\-drive-led <bool>
76: Show overlay drive led when statusbar isn't shown
1.1.1.4 root 77: .TP
78: .B \-\-spec512 <x>
79: Hatari uses this threshold to decide when to render a screen with
80: the slower but more accurate Spectrum512 screen conversion functions
81: (0 <= x <= 512, 0=disable)
82: .TP
83: .B \-\-bpp <bool>
1.1.1.5 root 84: Force internal bitdepth (x = 8/15/16/32, 0=disable)
1.1.1.4 root 85: .SH "VDI options"
1.1 root 86: .TP
1.1.1.5 root 87: .B \-\-vdi <bool>
88: Whether to use VDI screen mode
89: .TP
1.1.1.4 root 90: .B \-\-vdi\-planes <x>
91: Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
1.1 root 92: .TP
1.1.1.4 root 93: .B \-\-vdi\-width <w>
94: Use extended VDI resolution with width <w> (384 <= w <= 1024)
1.1 root 95: .TP
1.1.1.4 root 96: .B \-\-vdi\-height <h>
97: Use extended VDI resolution with height <h> (200 < h <= 768)
98: .SH "Devices options"
1.1 root 99: .TP
1.1.1.4 root 100: .B \-j, \-\-joystick <port>
101: Emulate joystick with cursor keys in given port (0-5)
1.1 root 102: .TP
1.1.1.5 root 103: .B \-\-joy<port> <type>
104: Set joystick type (none/keys/real) for given port
105: .TP
1.1.1.4 root 106: .B \-\-printer <file>
107: Enable printer support and write data to <file>
1.1.1.2 root 108: .TP
1.1.1.6 root 109: .B \-\-midi-in <filename>
110: Enable MIDI support and write MIDI data to <file>
1.1 root 111: .TP
1.1.1.6 root 112: .B \-\-midi-out <filename>
113: Enable MIDI support and read MIDI data from <file>
114: .TP
115: .B \-\-rs232-in <filename>
116: Enable serial port support and use <file> as the input device
117: .TP
118: .B \-\-rs232-out <filename>
119: Enable serial port support and use <file> as the output device
1.1.1.4 root 120: .SH "Disk options"
1.1.1.5 root 121: .TP
122: .B \-\-disk-a <file>
123: Set disk image for floppy drive A
124: .TP
125: .B \-\-disk-b <file>
126: Set disk image for floppy drive B
1.1 root 127: .TP
1.1.1.4 root 128: .B \-d, \-\-harddrive <dir>
1.1.1.5 root 129: Emulate an ST harddrive (<dir> = root directory)
1.1 root 130: .TP
1.1.1.4 root 131: .B \-\-acsi <file>
1.1.1.5 root 132: Emulate an ACSI hard disk with an image <file>
133: .TP
134: .B \-\-ide <file>
1.1.1.6 root 135: Emulate an IDE hard disk with an image <file>
1.1 root 136: .TP
1.1.1.4 root 137: .B \-\-slowfdc <bool>
1.1.1.5 root 138: slow down FDC emulation (deprecated)
1.1.1.4 root 139: .SH "Memory options"
1.1 root 140: .TP
1.1.1.4 root 141: .B \-s, \-\-memsize <x>
142: Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 KiB
1.1 root 143: .TP
1.1.1.4 root 144: .B \-t, \-\-tos <imagefile>
145: Specify TOS ROM image to use
1.1 root 146: .TP
1.1.1.4 root 147: .B \-\-cartridge <imagefile>
148: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
149: extended VDI resolution are disabled)
1.1 root 150: .TP
1.1.1.4 root 151: .B \-\-memstate <file>
152: Load memory snap-shot <file>
153: .SH "CPU options"
154: .TP
155: .B \-\-cpulevel <x>
156: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
157: .TP
158: .B \-\-cpuclock <x>
159: Set the CPU clock (8, 16 or 32 Mhz)
160: .TP
161: .B \-\-compatible <bool>
162: Use a more compatible but slower 68000 CPU mode
163: .SH "Misc system options"
1.1.1.3 root 164: .TP
165: .B \-\-machine <x>
1.1.1.4 root 166: select machine type (x = st, ste, tt or falcon)
167: .TP
168: .B \-\-blitter <bool>
1.1.1.5 root 169: Enable blitter emulation (ST only)
1.1.1.4 root 170: .TP
1.1.1.7 ! root 171: .B \-\-timer-d <bool>
! 172: Patch redundantly high Timer-D frequency set by TOS. This about doubles
! 173: Hatari speed as the original Timer-D frequency causes most of the interrupts.
! 174: .TP
1.1.1.4 root 175: .B \-\-dsp <x>
1.1.1.5 root 176: Falcon DSP emulation (x = none, dummy or emu, Falcon only)
1.1.1.4 root 177: .TP
178: .B \-\-sound <x>
1.1.1.7 ! root 179: Sound frequency: 6000-50066. "off" disables the sound and speeds up
! 180: the emulation. To prevent extra sound artifacts, the frequency should be
! 181: selected so that it either matches evenly with the STE/TT/Falcon sound
! 182: DMA (6258, 12517, 250033, 50066 Hz) or your sound card frequencies
! 183: (11025, 22050, 44100 or 6000...48000 Hz). Check what your sound card
! 184: supports.
! 185: .TP
1.1.1.5 root 186: .B \-k, \-\-keymap <file>
1.1.1.3 root 187: load keyboard mapping from <file>
1.1.1.4 root 188: .SH "Debug options"
189: .TP
1.1.1.7 ! root 190: .B \-D, \-\-debug
! 191: Toggle whether CPU exceptions invoke the debugger
1.1.1.5 root 192: .TP
193: .B \-\-bios-intercept
194: Enable Bios/XBios interception
1.1.1.4 root 195: .TP
196: .B \-\-trace <trace1,...>
1.1.1.5 root 197: Activate debug traces, see
198: .B \-\-trace help
199: for available tracing options
200: .TP
201: .B \-\-control-socket <file>
202: Hatari reads options from given socket at run-time
203: .TP
204: .B \-\-log-file <file>
205: Save log output to <file> (default=stderr)
206: .TP
207: .B \-\-log-level <x>
208: Log output level (x=debug/todo/info/warn/error/fatal)
209: .TP
210: .B \-\-alert-level <x>
211: Show dialog for log messages above given level
1.1.1.7 ! root 212: .TP
! 213: .B \-\-run-vbls <x>
! 214: Exit after X VBLs
1.1 root 215: .SH "COMMANDS"
1.1.1.3 root 216: The shortcut keys can be configured in the configuration file.
217: The default settings are:
1.1 root 218: .TP
219: .B AltGr + a
220: record animation
221: .TP
222: .B AltGr + g
223: grab a screenshot
224: .TP
225: .B AltGr + i
226: boss key: leave full screen mode and iconify window
227: .TP
228: .B AltGr + j
229: activate joystick emulation via cursor keys
230: .TP
231: .B AltGr + m
232: (un-)lock the mouse into the window
233: .TP
234: .B AltGr + r
1.1.1.5 root 235: warm reset the ST (same as the reset button)
1.1 root 236: .TP
237: .B AltGr + c
1.1.1.5 root 238: cold reset the ST (same as the power switch)
239: .TP
240: .B AltGr + d
241: open dialog to select/change disk A
1.1 root 242: .TP
243: .B AltGr + s
244: enable/disable sound
245: .TP
246: .B AltGr + q
247: quit the emulator
248: .TP
249: .B AltGr + x
250: toggle normal/max speed
251: .TP
252: .B AltGr + y
253: enable/disable sound recording
254: .TP
1.1.1.4 root 255: .B AltGr + k
256: save memory snapshot
257: .TP
258: .B AltGr + l
259: load memory snapshot
260: .TP
1.1 root 261: .B F11
262: toggle between fullscreen and windowed mode
263: .TP
264: .B F12
1.1.1.5 root 265: activate the hatari options GUI
1.1 root 266: .br
267: You may need to hold SHIFT down while in windowed mode.
268: .TP
269: .B Pause
1.1.1.7 ! root 270: Pauses the emulation
! 271: .TP
! 272: .B AltGr + Pause
! 273: Invokes the internal Hatari debugger
1.1 root 274:
275: .SH Emulated Atari ST keyboard
1.1.1.3 root 276: All other keys on the keyboard act as the normal Atari ST keys so
277: pressing SPACE on your PC will result in an emulated press of the
278: SPACE key on the ST. The following keys have special meanings:
1.1 root 279: .TP
280: .B Alt
281: will act as the ST's ALTERNATE key
282: .TP
283: .B left Ctrl
284: will act as the ST's CONTROL key
285: .TP
286: .B Page Up
287: will emulate the ST's HELP key
288: .TP
289: .B Page Down
290: will emulate the ST's UNDO key
291: .PP
292: .B AltGr
293: will act as
294: .B Alternate
1.1.1.3 root 295: as well as long as you do not press it together with a Hatari hotkey
296: combination.
1.1 root 297:
298: The
299: .B right Ctrl
1.1.1.3 root 300: key is used as the fire button of the emulated joystick when you turn
301: on joystick emulation via keyboard.
1.1 root 302:
1.1.1.3 root 303: The cursor keys will act as the cursor keys on the Atari ST as long as
304: joystick emulation via keyboard has been turned off.
1.1 root 305:
306: .SH "SEE ALSO"
307: The main program documentation, usually in /usr/share/doc/.
308: .PP
1.1.1.6 root 309: The homepage of hatari: http://hatari.berlios.de/
1.1 root 310:
1.1.1.5 root 311: .SH "FILES AND DIRECTORIES"
1.1.1.3 root 312: .TP
313: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
1.1.1.5 root 314: The global configuration file of Hatari.
315: .TP
316: ~/.hatari/
317: The (default) directory for user's personal Hatari files;
318: .B hatari.cfg
319: (configuration file),
320: .B hatari.nvram
321: (NVRAM content file),
322: .B hatari.sav
323: (Hatari memory state snapshot file which Hatari can load/save automatically
324: when it starts/exits),
325: .B hatari.prn
326: (printer output file),
327: .B hatari.wav
328: (recorded sound output in WAV format),
329: .B hatari.ym
330: (recorded sound output in YM format).
1.1.1.3 root 331: .TP
1.1.1.5 root 332: /usr/share/hatari/ (or /usr/local/share/hatari/)
333: The global data directory of Hatari.
1.1.1.3 root 334: .TP
335: tos.img
336: The TOS ROM image will be loaded from the data directory of Hatari unless it
337: is specified on the command line or the configuration file.
338:
1.1 root 339: .SH "AUTHOR"
1.1.1.5 root 340: This manual page was written by Marco Herrn <[email protected]> for the
341: Debian project and later modified by Thomas Huth and Eero Tamminen to
342: 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.