|
|
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.4 ! root 5: .TH "HATARI" "1" "2008-03-14" "Hatari" ""
1.1 root 6: .\" Please adjust this date whenever revising the manpage.
7:
8: .SH "NAME"
1.1.1.3 root 9: hatari \- Atari ST(e) emulator
1.1 root 10: .SH "SYNOPSIS"
11: .B hatari
12: .RI [options]
13: .RI [diskimage]
14: .SH "DESCRIPTION"
1.1.1.3 root 15: Hatari is an Atari ST(e) emulator for Linux, FreeBSD, BeOS and other
16: 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
19: ST or Atari STE. It supports the commonly used *.st and *.msa disk
20: 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
! 37: .B \--confirm-quit <bool>
! 38: Whether Hatari confirms quitting
! 39: .TP
! 40: .B \-c, \-\-configfile <filename>
! 41: use the mentioned file as configuration file instead of ~/.hatari.cfg
! 42: .SH "Display options"
1.1 root 43: .TP
44: .B \-m, \-\-mono
1.1.1.4 ! root 45: Start in monochrome mode instead of color
! 46: .TP
! 47: .B \-\-monitor <x>
! 48: Select monitor type (x = mono/rgb/vga/tv)
1.1 root 49: .TP
50: .B \-f, \-\-fullscreen
1.1.1.4 ! root 51: Start the emulator in fullscreen mode
1.1.1.2 root 52: .TP
53: .B \-w, \-\-window
1.1.1.4 ! root 54: Start the emulator in window mode
1.1 root 55: .TP
1.1.1.4 ! root 56: .B \-z, \-\-zoom <x>
! 57: Zoom low resolution (1=no, 2=yes)
1.1 root 58: .TP
1.1.1.4 ! root 59: .B \-\-frameskips <x>
! 60: Skip <x> frames after each displayed frame to accelerate emulation
! 61: (0 <= x <= 8)
1.1 root 62: .TP
1.1.1.4 ! root 63: .B \-\-borders <bool>
! 64: Show screen borders (for overscan demos etc)
! 65: .TP
! 66: .B \-\-spec512 <x>
! 67: Hatari uses this threshold to decide when to render a screen with
! 68: the slower but more accurate Spectrum512 screen conversion functions
! 69: (0 <= x <= 512, 0=disable)
! 70: .TP
! 71: .B \-\-bpp <bool>
! 72: Force given internal bitdepth (x=8/16/32, x=0 for autodetection).
! 73: 8-bit color depth may be useful for older host computers
! 74: .SH "VDI options"
1.1 root 75: .TP
1.1.1.4 ! root 76: .B \-\-vdi\-planes <x>
! 77: Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
1.1 root 78: .TP
1.1.1.4 ! root 79: .B \-\-vdi\-width <w>
! 80: Use extended VDI resolution with width <w> (384 <= w <= 1024)
1.1 root 81: .TP
1.1.1.4 ! root 82: .B \-\-vdi\-height <h>
! 83: Use extended VDI resolution with height <h> (200 < h <= 768)
! 84: .SH "Devices options"
1.1 root 85: .TP
1.1.1.4 ! root 86: .B \-j, \-\-joystick <port>
! 87: Emulate joystick with cursor keys in given port (0-5)
1.1 root 88: .TP
1.1.1.4 ! root 89: .B \-\-printer <file>
! 90: Enable printer support and write data to <file>
1.1.1.2 root 91: .TP
1.1.1.4 ! root 92: .B \-\-midi <filename>
! 93: Enable experimental MIDI output to the mentioned file
1.1 root 94: .TP
1.1.1.4 ! root 95: .B \-\-rs232 <filename>
! 96: Enable experimental RS232 emulation via the mentioned file/device
! 97: .SH "Disk options"
1.1 root 98: .TP
1.1.1.4 ! root 99: .B \-d, \-\-harddrive <dir>
! 100: Use <dir> as an emulated hard disk
1.1 root 101: .TP
1.1.1.4 ! root 102: .B \-\-acsi <file>
! 103: Emulate ACSI hard disk with an image <file>
1.1 root 104: .TP
1.1.1.4 ! root 105: .B \-\-slowfdc <bool>
! 106: slow down FDC emulation (needed to make some games and demos work)
! 107: .SH "Memory options"
1.1 root 108: .TP
1.1.1.4 ! root 109: .B \-s, \-\-memsize <x>
! 110: Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 KiB
1.1 root 111: .TP
1.1.1.4 ! root 112: .B \-t, \-\-tos <imagefile>
! 113: Specify TOS ROM image to use
1.1 root 114: .TP
1.1.1.4 ! root 115: .B \-\-cartridge <imagefile>
! 116: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
! 117: extended VDI resolution are disabled)
1.1 root 118: .TP
1.1.1.4 ! root 119: .B \-\-memstate <file>
! 120: Load memory snap-shot <file>
! 121: .SH "CPU options"
! 122: .TP
! 123: .B \-\-cpulevel <x>
! 124: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
! 125: .TP
! 126: .B \-\-cpuclock <x>
! 127: Set the CPU clock (8, 16 or 32 Mhz)
! 128: .TP
! 129: .B \-\-compatible <bool>
! 130: Use a more compatible but slower 68000 CPU mode
! 131: .SH "Misc system options"
1.1.1.3 root 132: .TP
133: .B \-\-machine <x>
1.1.1.4 ! root 134: select machine type (x = st, ste, tt or falcon)
! 135: .TP
! 136: .B \-\-blitter <bool>
! 137: Enable blitter emulation
! 138: .TP
! 139: .B \-\-dsp <x>
! 140: Falcon DSP emulation (x = none, dummy or emu)
! 141: .TP
! 142: .B \-\-sound <x>
! 143: Sound quality (off/low/med/hi (off=faster))
1.1.1.3 root 144: .TP
145: .B \-\-keymap <file>
146: load keyboard mapping from <file>
1.1.1.4 ! root 147: .SH "Debug options"
! 148: .TP
! 149: .B \-D, \-\-debug <bool>
! 150: activate the simple builtin debugger
! 151: .TP
! 152: .B \-\-log <file>
! 153: Save log to <file> (can also be "stdout" or "stderr")
! 154: .TP
! 155: .B \-\-trace <trace1,...>
! 156: Activate debug traces, see --trace help for tracing options
1.1 root 157: .SH "COMMANDS"
1.1.1.3 root 158: The shortcut keys can be configured in the configuration file.
159: The default settings are:
1.1 root 160: .TP
161: .B AltGr + a
162: record animation
163: .TP
164: .B AltGr + g
165: grab a screenshot
166: .TP
167: .B AltGr + i
168: boss key: leave full screen mode and iconify window
169: .TP
170: .B AltGr + j
171: activate joystick emulation via cursor keys
172: .TP
173: .B AltGr + m
174: (un-)lock the mouse into the window
175: .TP
176: .B AltGr + r
177: (warm) reset the ST
178: .TP
179: .B AltGr + c
180: coldreset the ST (same as the original power switch)
181: .TP
182: .B AltGr + s
183: enable/disable sound
184: .TP
185: .B AltGr + q
186: quit the emulator
187: .TP
188: .B AltGr + x
189: toggle normal/max speed
190: .TP
191: .B AltGr + y
192: enable/disable sound recording
193: .TP
1.1.1.4 ! root 194: .B AltGr + k
! 195: save memory snapshot
! 196: .TP
! 197: .B AltGr + l
! 198: load memory snapshot
! 199: .TP
1.1 root 200: .B F11
201: toggle between fullscreen and windowed mode
202: .TP
203: .B F12
204: activate the hatari command GUI
205: .br
206: You may need to hold SHIFT down while in windowed mode.
207: .TP
208: .B Pause
1.1.1.2 root 209: will go to the debugger if it was activated with the -\-debug option
1.1 root 210:
211: .SH Emulated Atari ST keyboard
1.1.1.3 root 212: All other keys on the keyboard act as the normal Atari ST keys so
213: pressing SPACE on your PC will result in an emulated press of the
214: SPACE key on the ST. The following keys have special meanings:
1.1 root 215: .TP
216: .B Alt
217: will act as the ST's ALTERNATE key
218: .TP
219: .B left Ctrl
220: will act as the ST's CONTROL key
221: .TP
222: .B Page Up
223: will emulate the ST's HELP key
224: .TP
225: .B Page Down
226: will emulate the ST's UNDO key
227: .PP
228: .B AltGr
229: will act as
230: .B Alternate
1.1.1.3 root 231: as well as long as you do not press it together with a Hatari hotkey
232: combination.
1.1 root 233:
234: The
235: .B right Ctrl
1.1.1.3 root 236: key is used as the fire button of the emulated joystick when you turn
237: on joystick emulation via keyboard.
1.1 root 238:
1.1.1.3 root 239: The cursor keys will act as the cursor keys on the Atari ST as long as
240: joystick emulation via keyboard has been turned off.
1.1 root 241:
242: .SH "SEE ALSO"
243: The main program documentation, usually in /usr/share/doc/.
244: .PP
245: The homepage of hatari: http://hatari.sourceforge.net
246:
1.1.1.3 root 247: .SH "FILES"
248: .TP
249: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
250: the global configuration file of Hatari
251: .TP
252: ~/.hatari.cfg
253: the user's personal Hatari configuration file
254: .TP
255: tos.img
256: The TOS ROM image will be loaded from the data directory of Hatari unless it
257: is specified on the command line or the configuration file.
258:
1.1 root 259: .SH "AUTHOR"
1.1.1.3 root 260: This manual page was written by Marco Herrn <[email protected]>, for the
261: Debian project and later modified by Thomas Huth to suit the latest
1.1 root 262: version of Hatari.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.