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