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