![[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.13 root 5: .TH "HATARI" "1" "2014-05-08" "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.1.14 root 10:
1.1 root 11: .SH "SYNOPSIS"
12: .B hatari
13: .RI [options]
1.1.1.9 root 14: .RI [directory|diskimage|program]
1.1.1.14 root 15:
1.1 root 16: .SH "DESCRIPTION"
1.1.1.5 root 17: Hatari is an Atari ST/STE/TT/Falcon emulator for Linux, FreeBSD, BeOS and
18: other Systems which are supported by the SDL library.
1.1 root 19: .PP
1.1.1.16 root 20: With Hatari one can run games, demos or applications written for Atari
1.1.1.8 root 21: ST, STE or Falcon. Atari TT support is experimental. Hatari supports
1.1.1.16 root 22: the commonly used *.st, *.msa and *.stx disk images, and hard disk
23: emulation.
1.1 root 24: .PP
1.1.1.3 root 25: To run the emulator a TOS ROM image is needed. EmuTOS, a free
1.1.1.16 root 26: implementation of TOS is shipped with Hatari. It boots faster than
27: original TOS versions, but some buggy (floppy only) programs won't
1.1.1.17! root 28: work correctly with it. For best compatibility, it is recommended to
1.1.1.16 root 29: use a TOS ROM from a real Atari.
1.1.1.9 root 30: .PP
1.1.1.16 root 31: As an argument, one can give either a name of a directory that should
1.1.1.9 root 32: be emulated as a virtual GEMDOS hard disk, a floppy disk image or an
33: Atari program that should be autostarted. In the last case the
34: program's directory will be used as the C: drive from where this
1.1.1.16 root 35: program will be started. These shortcuts correspond to "-d <dir>",
36: "--disk-a <floppy image>" and "-d <dir> --auto C:\<program>"
37: options.
1.1.1.9 root 38: .PP
39: Booting will be done from the disk image or directory that's given
40: last on the command line as an option or the argument (and which
1.1.1.13 root 41: corresponds to A: or C:). If you want to give floppy image name with
42: an autostarting program name, give it with --disk-a option before the
43: program name.
1.1.1.14 root 44:
1.1 root 45: .SH "OPTIONS"
1.1.1.4 root 46: Hatari options are split into several categories:
1.1.1.14 root 47:
1.1.1.4 root 48: .SH "General options"
1.1.1.17! root 49: .TP
1.1 root 50: .B \-h, \-\-help
1.1.1.4 root 51: Print command line options and terminate
1.1.1.17! root 52: .TP
1.1 root 53: .B \-v, \-\-version
1.1.1.4 root 54: Print version information and terminate
1.1.1.17! root 55: .TP
1.1.1.12 root 56: .B \-\-confirm\-quit <bool>
1.1.1.4 root 57: Whether Hatari confirms quitting
1.1.1.17! root 58: .TP
1.1.1.4 root 59: .B \-c, \-\-configfile <filename>
1.1.1.12 root 60: Read additional configuration values from <file>, these
61: override values read from the global and user configuration
62: files
1.1.1.9 root 63: .TP
64: .B \-k, \-\-keymap <file>
1.1.1.12 root 65: Load keyboard mapping from <file>
1.1.1.17! root 66: .TP
1.1.1.12 root 67: .B \-\-fast\-forward <bool>
1.1.1.5 root 68: On fast machine helps skipping (fast forwarding) Hatari output
1.1.1.17! root 69: .TP
1.1.1.16 root 70: .B \-\-auto <program>
71: Autostarts given program, if TOS finds it. Program needs to
72: be given with full path it will have under emulation, for
73: example "C:\\DIR\\PROGRAM.PRG". This is implemented by providing
74: TOS a virtual INF file, including that path as what TOS should
75: start automatically
1.1.1.14 root 76:
1.1.1.9 root 77: .SH "Common display options"
1.1.1.17! root 78: .TP
1.1 root 79: .B \-m, \-\-mono
1.1.1.4 root 80: Start in monochrome mode instead of color
1.1.1.17! root 81: .TP
1.1.1.4 root 82: .B \-\-monitor <x>
83: Select monitor type (x = mono/rgb/vga/tv)
1.1.1.17! root 84: .TP
1.1.1.16 root 85: .B \-\-tos-res <x>
86: Select TOS resolution for color monitors (x = low/med/high/ttlow/ttmed)
87: .TP
1.1 root 88: .B \-f, \-\-fullscreen
1.1.1.4 root 89: Start the emulator in fullscreen mode
1.1.1.17! root 90: .TP
1.1.1.2 root 91: .B \-w, \-\-window
1.1.1.13 root 92: Start the emulator in windowed mode
1.1.1.17! root 93: .TP
1.1.1.7 root 94: .B \-\-grab
1.1.1.13 root 95: Grab mouse (also) in windowed mode
1.1.1.17! root 96: .TP
1.1.1.16 root 97: .B \-\-resizable <bool>
98: Allow window resizing
99:
100: NOTE: this is supported only by Hatari SDL2 build
101: .TP
1.1.1.13 root 102: .B \-\-borders <bool>
103: Show ST/STE/Falcon screen borders (for low/med resolution overscan demos)
1.1.1.17! root 104: .TP
1.1.1.4 root 105: .B \-\-frameskips <x>
106: Skip <x> frames after each displayed frame to accelerate emulation
1.1.1.5 root 107: (0=disabled, >4 uses automatic frameskip with given value as maximum)
1.1.1.13 root 108: .TP
109: .B \-\-slowdown <x>
110: Slow down emulation by factor of x (used as multiplier for VBL wait time)
1.1.1.14 root 111: .TP
112: .B \-\-mousewarp <bool>
113: To keep host mouse better in sync with Atari mouse pointer, center it
114: to Hatari window on cold reset and resolution changes
115: .TP
1.1.1.5 root 116: .B \-\-statusbar <bool>
117: Show statusbar (with floppy leds etc etc)
1.1.1.16 root 118: .TP
1.1.1.12 root 119: .B \-\-drive\-led <bool>
1.1.1.5 root 120: Show overlay drive led when statusbar isn't shown
1.1.1.4 root 121: .TP
1.1.1.13 root 122: .B \-\-max\-width <x>
123: Preferred / maximum window width for borders / zooming
124: .TP
125: .B \-\-max\-height <x>
126: Preferred / maximum window height for borders / zooming
127: .TP
1.1.1.9 root 128: .B \-\-bpp <bool>
129: Force internal bitdepth (x = 8/15/16/32, 0=disable)
1.1.1.16 root 130: .TP
131: .B \-\-disable\-video <bool>
132: Run emulation without displaying video (audio only)
1.1.1.14 root 133:
1.1.1.9 root 134: .SH "ST/STE specific display options"
135: .TP
1.1.1.12 root 136: .B \-\-desktop\-st <bool>
1.1.1.15 root 137: NOTE: this has effect only for SDL1 Hatari build. In SDL2 build,
138: \fB--desktop\fP option controls also ST/STe mode.
139:
140: Whether to use desktop resolution on fullscreen to avoid issues
141: related to resolution switching (messing multi-screen setups, several
142: seconds delay needed for resolution switching by some LCD monitors and
143: the resulting sound break). Otherwise fullscreen will use a resolution
144: that is closest to the Hatari window size.
145:
146: As Hatari ST/STe display code doesn't support zooming (except low-rez
147: doubling), it doesn't get scaled (by Hatari or monitor) when this is
148: enabled, and you may get large black borders around ST/STe screen.
1.1.1.10 root 149: Therefore this is mainly useful only if you suffer from the described
150: effects, but still want to grab mouse and remove other distractions
1.1.1.15 root 151: from the screen just by toggling fullscreen mode. (disabled by
152: default)
1.1.1.17! root 153: .TP
1.1.1.4 root 154: .B \-\-spec512 <x>
155: Hatari uses this threshold to decide when to render a screen with
156: the slower but more accurate Spectrum512 screen conversion functions
157: (0 <= x <= 512, 0=disable)
1.1.1.17! root 158: .TP
1.1.1.9 root 159: .B \-z, \-\-zoom <x>
160: Zoom (double) low resolution (1=no, 2=yes)
1.1.1.15 root 161: .TP
162: .B \-\-video-timing <x>
1.1.1.17! root 163: Wakeup State for MMU/GLUE (x=ws1/ws2/ws3/ws4/random,
1.1.1.15 root 164: default ws3). When powering on, the STF will randomly choose one of these
165: wake up states. The state will then affect the timings where border removals
166: and other video tricks should be made, which can give different results on
167: screen. For example, WS3 is known to be compatible with many demos, while WS1 can show
168: more problems.
1.1.1.14 root 169:
1.1.1.13 root 170: .SH "TT/Falcon specific display options"
1.1.1.9 root 171: Zooming to sizes specified below is internally done using integer scaling
172: factors. This means that different Atari resolutions may show up with
173: different sizes, but they are never blurry.
1.1.1.17! root 174: .TP
1.1.1.9 root 175: .B \-\-desktop <bool>
176: Whether to use desktop resolution on fullscreen to avoid issues
177: related to resolution switching. Otherwise fullscreen will use
1.1.1.10 root 178: a resolution that is closest to the Hatari window size.
179: (enabled by default)
1.1.1.4 root 180: .TP
1.1.1.12 root 181: .B \-\-force\-max <bool>
1.1.1.10 root 182: Hatari window size is forced to specified maximum size and black borders
183: used when Atari resolution doesn't scale evenly to it. This is most
184: useful when recording videos of Falcon demos that change their
185: resolution. (disabled by default)
186: .TP
1.1.1.9 root 187: .B \-\-aspect <bool>
188: Whether to do monitor aspect ratio correction (enabled by default)
1.1.1.14 root 189:
1.1.1.4 root 190: .SH "VDI options"
1.1.1.10 root 191: .TP
1.1.1.5 root 192: .B \-\-vdi <bool>
1.1.1.14 root 193: Whether to use VDI screen mode. Doesn't work with TOS v4.
194: TOS v3 memory detection isn't compatible with larger VDI modes
195: (i.e. you need to skip the detection at boot)
1.1.1.10 root 196: .TP
1.1.1.4 root 197: .B \-\-vdi\-planes <x>
198: Use extended VDI resolution with bit depth <x> (x = 1, 2 or 4)
1.1.1.10 root 199: .TP
1.1.1.4 root 200: .B \-\-vdi\-width <w>
1.1.1.17! root 201: Use extended VDI resolution with width <w> (320 < w <= 2048)
1.1.1.10 root 202: .TP
1.1.1.4 root 203: .B \-\-vdi\-height <h>
1.1.1.17! root 204: Use extended VDI resolution with height <h> (200 < h <= 1280)
! 205: .PP
! 206: TOS and some popular GEM programs add extra restrictions for the VDI
! 207: screen size. In total screen can take at maximum 300kB, width needs
! 208: to be multiple of 128/planes, and height multiple of 16 pixels (or 8,
! 209: depending on system font height). That translates to following maximum
! 210: standard resolutions for the VDI mode:
! 211: .TP
! 212: .B monochrome
! 213: FullHD (1920×1080), WUXGA (1920x1200) and QWXGA (2048x1152)
! 214: .TP
! 215: .B 2 plane mode (4 colors)
! 216: HD (1280x720), WXGA (1280x768) and XGA+ (1152x864)
! 217: .TP
! 218: .B 4 plane mode (16-colors)
! 219: qHD (960x540), DVGA (960x640) and WSVGA (1024x600)
1.1.1.14 root 220:
1.1.1.9 root 221: .SH "Screen capture options"
222: .TP
223: .B \-\-crop <bool>
224: Remove statusbar from the screen captures
1.1.1.8 root 225: .TP
226: .B \-\-avirecord
1.1.1.14 root 227: Start AVI recording. Note: recording will automatically
228: stop when emulation resolution changes.
1.1.1.8 root 229: .TP
1.1.1.12 root 230: .B \-\-avi\-vcodec <x>
1.1.1.14 root 231: Select AVI video codec (x = bmp/png). PNG compression can
232: be \fImuch\fP slower than using the uncompressed BMP format,
233: but uncompressed video content takes huge amount of space.
234: .TP
235: .B \-\-png\-level <x>
236: Select PNG compression level for AVI video (x = 0-9).
237: Both compression efficiency and speed depend on the compressed
238: screen content. Highest compression level (9) can be \fIreally\fP
239: slow with some content. Levels 3-6 should compress nearly as well
240: with clearly smaller CPU overhead.
1.1.1.8 root 241: .TP
1.1.1.12 root 242: .B \-\-avi\-fps <x>
1.1.1.14 root 243: Force AVI frame rate (x = 50/60/71/...)
1.1.1.8 root 244: .TP
1.1.1.12 root 245: .B \-\-avi\-file <file>
1.1.1.14 root 246: Use <file> to record AVI
247:
1.1.1.4 root 248: .SH "Devices options"
1.1.1.17! root 249: .TP
1.1.1.4 root 250: .B \-j, \-\-joystick <port>
251: Emulate joystick with cursor keys in given port (0-5)
1.1.1.17! root 252: .TP
1.1.1.5 root 253: .B \-\-joy<port> <type>
254: Set joystick type (none/keys/real) for given port
1.1.1.17! root 255: .TP
1.1.1.4 root 256: .B \-\-printer <file>
257: Enable printer support and write data to <file>
1.1.1.17! root 258: .TP
1.1.1.16 root 259: .B \-\-midi <bool>
260: Whether to enable MIDI support (PortMidi only)
1.1.1.17! root 261: .TP
1.1.1.12 root 262: .B \-\-midi\-in <filename>
1.1.1.16 root 263: Enable MIDI support and write raw MIDI data to <file> (Linux only)
1.1.1.17! root 264: .TP
1.1.1.12 root 265: .B \-\-midi\-out <filename>
1.1.1.16 root 266: Enable MIDI support and read raw MIDI data from <file> (Linux only)
1.1.1.17! root 267: .TP
1.1.1.12 root 268: .B \-\-rs232\-in <filename>
1.1.1.17! root 269: Enable MFP serial port support and use <file> as the input device
! 270: .TP
1.1.1.12 root 271: .B \-\-rs232\-out <filename>
1.1.1.17! root 272: Enable MFP serial port support and use <file> as the output device
! 273: .TP
! 274: .B \-\-scc\-b\-out <filename>
! 275: Enable SCC channel B serial port support and use <file> for the output
! 276: (only for Mega-STE, TT and Falcon)
1.1.1.14 root 277:
278: .SH "Floppy drive options"
1.1.1.5 root 279: .TP
1.1.1.13 root 280: .B \-\-drive\-a <bool>
281: Enable/disable drive A (default is on)
282: .TP
283: .B \-\-drive\-b <bool>
284: Enable/disable drive B (default is on)
285: .TP
286: .B \-\-drive\-a\-heads <x>
287: Set number of heads for drive A (1=single sided, 2=double sided)
288: .TP
289: .B \-\-drive\-b\-heads <x>
290: Set number of heads for drive B (1=single sided, 2=double sided)
291: .TP
1.1.1.12 root 292: .B \-\-disk\-a <file>
1.1.1.5 root 293: Set disk image for floppy drive A
294: .TP
1.1.1.12 root 295: .B \-\-disk\-b <file>
1.1.1.5 root 296: Set disk image for floppy drive B
1.1.1.17! root 297: .TP
1.1.1.14 root 298: .B \-\-fastfdc <bool>
299: speed up FDC emulation (can cause incompatibilities)
1.1.1.8 root 300: .TP
1.1.1.12 root 301: .B \-\-protect\-floppy <x>
1.1.1.8 root 302: Write protect floppy image contents (on/off/auto). With "auto" option
1.1.1.13 root 303: write protection is according to the disk image file attributes
1.1.1.14 root 304:
305: .SH "Hard drive options"
306: .TP
307: .B \-d, \-\-harddrive <dir>
1.1.1.16 root 308: GEMDOS HD emulation. Emulate harddrive partition(s) with <dir> contents.
309: If directory contains only single letter (C-Z) subdirectories, each of these
1.1.1.14 root 310: subdirectories will be treated as a separate partition, otherwise the
311: given directory itself will be assigned to drive "C:". In the multiple
312: partition case, the letters used as the subdirectory names will
1.1.1.17! root 313: determine to which drives/partitions they are assigned. If <dir> is
1.1.1.14 root 314: an empty string, then harddrive's emulation is disabled
1.1.1.8 root 315: .TP
1.1.1.12 root 316: .B \-\-protect\-hd <x>
1.1.1.8 root 317: Write protect harddrive <dir> contents (on/off/auto). With "auto" option
318: the protection can be controlled by setting individual files attributes
319: as it disables the file attribute modifications for the GEMDOS hard disk
1.1.1.13 root 320: emulation
1.1.1.12 root 321: .TP
322: .B \-\-gemdos\-case <x>
323: Specify whether new dir/filenames are forced to be in upper or lower case
1.1.1.13 root 324: with the GEMDOS HD emulation. Off/upper/lower, off by default
1.1.1.10 root 325: .TP
1.1.1.16 root 326: .B \-\-gemdos\-time <x>
327: Specify what file modification timestamps should be used, emulation
328: internal (atari) ones, or ones from the machine (host) on which the
329: machine is running. While Atari emulation and host clocks are in sync
330: at Hatari startup, they will diverge while emulation is running,
331: especially if you use fast forward. Default is "atari". If you
332: modify files accessed by the Atari side, directly from the host side
333: while Hatari is already running, you may want to use "host" option
334: .TP
1.1.1.14 root 335: .B \-\-gemdos\-conv <bool>
336: Whether GEMDOS file names with 8-bit (non-ASCII) characters are
337: converted between Atari and host character sets. On Linux, host file
338: name character set is assumed to be UTF-8. This option is disabled by
1.1.1.17! root 339: default, in case you have transferred files from Atari machine without
1.1.1.14 root 340: proper file name conversion (e.g. by zipping them on Atari and
1.1.1.16 root 341: unzipping on PC)
342: .TP
343: .B \-\-gemdos\-drive <drive>
1.1.1.17! root 344: Assign (separately specified) GEMDOS HD to given drive letter (C-Z)
1.1.1.16 root 345: instead of default C:, or use "skip" to specify that Hatari should
346: add GEMDOS HD after IDE and ACSI drives (assumes Hatari and native
1.1.1.17! root 347: HD driver parse same number of partitions from the partition tables
! 348: in HD images)
1.1.1.14 root 349: .TP
350: .B \-\-acsi <id>=<file>
351: Emulate an ACSI hard disk with given BUS ID (0-7) using image <file>.
1.1.1.17! root 352: If just a filename is given, it is assigned to BUS ID 0
! 353: .TP
! 354: .B \-\-scsi <id>=<file>
! 355: Emulate a SCSI hard disk with given BUS ID (0-7) using image <file>.
! 356: If just a filename is given, it is assigned to BUS ID 0
! 357: .TP
1.1.1.8 root 358: .B \-\-ide\-master <file>
1.1.1.17! root 359: Emulate an IDE 0 (master) hard disk with an image <file>
! 360: .TP
1.1.1.8 root 361: .B \-\-ide\-slave <file>
1.1.1.17! root 362: Emulate an IDE 1 (slave) hard disk with an image <file>
! 363: .TP
! 364: .B \-\-ide\-swap <id>=<x>
! 365: Set byte-swap option <x> (off/on/auto) for given IDE <id> (0/1).
! 366: If just option is given, it is applied to IDE 0
1.1.1.14 root 367:
1.1.1.4 root 368: .SH "Memory options"
1.1.1.17! root 369: .TP
1.1.1.10 root 370: .B \-\-memstate <file>
371: Load memory snap-shot <file>
1.1.1.17! root 372: .TP
1.1.1.4 root 373: .B \-s, \-\-memsize <x>
1.1.1.16 root 374: Set amount of emulated ST RAM, x = 1 to 14 MiB, or 0 for 512 KiB.
375: Other values are considered as a size in KiB
1.1.1.14 root 376: .TP
377: .B \-s, \-\-ttram <x>
1.1.1.17! root 378: Set amount of emulated TT RAM, x = 0 to 512 MiB (in 4MB steps)
1.1.1.14 root 379:
1.1.1.10 root 380: .SH "ROM options"
1.1.1.17! root 381: .TP
1.1.1.4 root 382: .B \-t, \-\-tos <imagefile>
383: Specify TOS ROM image to use
1.1.1.17! root 384: .TP
1.1.1.12 root 385: .B \-\-patch\-tos <bool>
1.1.1.10 root 386: Use this option to enable/disable TOS ROM patching. Experts only! Leave
387: this enabled unless you know what you are doing!
1.1.1.17! root 388: .TP
1.1.1.4 root 389: .B \-\-cartridge <imagefile>
390: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
391: extended VDI resolution are disabled)
1.1.1.14 root 392:
1.1.1.15 root 393: .SH "Common CPU options"
1.1.1.17! root 394: .TP
1.1.1.4 root 395: .B \-\-cpulevel <x>
396: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
1.1.1.17! root 397: .TP
1.1.1.4 root 398: .B \-\-cpuclock <x>
399: Set the CPU clock (8, 16 or 32 Mhz)
1.1.1.17! root 400: .TP
1.1.1.4 root 401: .B \-\-compatible <bool>
1.1.1.9 root 402: Use a more compatible, but slower 68000 CPU mode with
403: better prefetch accuracy and cycle counting
1.1.1.14 root 404:
1.1.1.15 root 405: .SH "WinUAE CPU core options"
406: .TP
407: .B \-\-cpu\-exact <bool>
408: Use cycle exact CPU emulation (cache emulation)
409: .TP
410: .B \-\-addr24 <bool>
411: Use 24-bit instead of 32-bit addressing mode
412: (24-bit is enabled by default)
413: .TP
414: .B \-\-fpu <x>
415: FPU type (x=none/68881/68882/internal)
416: .TP
1.1.1.17! root 417: .B \-\-fpu-softfloat <bool>
! 418: Use full software FPU emulation (Softfloat library)
! 419: .TP
1.1.1.15 root 420: .B \-\-mmu <bool>
421: Use MMU emulation
422:
1.1.1.4 root 423: .SH "Misc system options"
1.1.1.17! root 424: .TP
1.1.1.3 root 425: .B \-\-machine <x>
1.1.1.16 root 426: Select machine type (x = st, megast, ste, megaste, tt or falcon)
1.1.1.17! root 427: .TP
1.1.1.4 root 428: .B \-\-blitter <bool>
1.1.1.5 root 429: Enable blitter emulation (ST only)
1.1.1.17! root 430: .TP
1.1.1.4 root 431: .B \-\-dsp <x>
1.1.1.5 root 432: Falcon DSP emulation (x = none, dummy or emu, Falcon only)
1.1.1.17! root 433: .TP
1.1.1.12 root 434: .B \-\-timer\-d <bool>
1.1.1.10 root 435: Patch redundantly high Timer-D frequency set by TOS. This about doubles
436: Hatari speed (for ST/e emulation) as the original Timer-D frequency causes
437: most of the interrupts.
438: .TP
1.1.1.12 root 439: .B \-\-fast\-boot <bool>
1.1.1.10 root 440: Patch TOS and initialize the so-called "memvalid" system variables to by-pass
441: the memory test of TOS, so that the system boots faster.
1.1.1.14 root 442:
1.1.1.10 root 443: .SH "Sound options"
1.1.1.17! root 444: .TP
1.1.1.9 root 445: .B \-\-mic <bool>
446: Enable/disable (Falcon only) microphone
1.1.1.17! root 447: .TP
1.1.1.4 root 448: .B \-\-sound <x>
1.1.1.7 root 449: Sound frequency: 6000-50066. "off" disables the sound and speeds up
450: the emulation. To prevent extra sound artifacts, the frequency should be
451: selected so that it either matches evenly with the STE/TT/Falcon sound
452: DMA (6258, 12517, 250033, 50066 Hz) or your sound card frequencies
453: (11025, 22050, 44100 or 6000...48000 Hz). Check what your sound card
454: supports.
1.1.1.17! root 455: .TP
1.1.1.12 root 456: .B \-\-sound\-buffer\-size <x>
1.1.1.9 root 457: SDL's sound buffer size: 10-100, or 0 to use default buffer size.
1.1.1.8 root 458: By default Hatari uses an SDL buffer size of 1024 samples, which
459: gives approximatively 20-30 ms of sound depending on the chosen sound
460: frequency. Under some OS or with not fully supported sound card, this
461: default setting can cause a bigger delay at lower frequency (nearly 0.5 sec).
462: In that case, you can use this option to force the size of the sound
463: buffer to a fixed number of milliseconds of sound (using 20 is often
464: a good choice if you have such problems). Most users will not need this option.
1.1.1.17! root 465: .TP
1.1.1.12 root 466: .B \-\-sound\-sync <bool>
467: The emulation rate is nudged by +100 or 0 or \-100 micro-seconds on occasion.
1.1.1.11 root 468: This prevents the sound buffer from overflowing (long latency and
469: lost samples) or underflowing (short latency and repeated samples).
470: The emulation rate smoothly deviates by a maximum of 0.58% until
471: synchronized, while the emulator continuously generates every sound
472: sample and the crystal controlled sound system consumes every sample.
473: .br
474: (on|off, off=default)
1.1.1.17! root 475: .TP
1.1.1.12 root 476: .B \-\-ym\-mixing <x>
1.1.1.9 root 477: Select a method for mixing the three YM2149 voice volumes together.
1.1.1.10 root 478: "model" uses a mathematical model of the YM voices,
1.1.1.9 root 479: "table" uses a lookup table of audio output voltage values measured
480: on STF and "linear" just averages the 3 YM voices.
1.1.1.14 root 481:
1.1.1.4 root 482: .SH "Debug options"
1.1.1.14 root 483: .TP
484: .B \-W, \-\-wincon
485: Open console window (Windows only)
1.1.1.17! root 486: .TP
1.1.1.7 root 487: .B \-D, \-\-debug
488: Toggle whether CPU exceptions invoke the debugger
1.1.1.17! root 489: .TP
1.1.1.13 root 490: .B \-\-debug\-except <flags>
491: Specify which exceptions invoke debugger, see
492: .B \-\-debug\-except help
493: for available (comma separated) exception flags.
1.1.1.17! root 494: .TP
! 495: .B \-\-bios\-intercept <bool>
! 496: Enable/Disable XBios command parsing. Allows Atari programs to use all
! 497: Hatari functionality and change Hatari state through Hatari specific
1.1.1.13 root 498: XBios(255) calls. XBios(20) printscreen calls produce also Hatari
1.1.1.17! root 499: screenshots. XBios(11) Dbmsg call can be used to invoke the debugger.
1.1.1.13 root 500: .TP
1.1.1.12 root 501: .B \-\-conout <device>
502: Enable console (xconout vector functions) output redirection for given
503: <device> to host terminal. Device 2 is for the (CON:) VT52 console,
504: which vector function catches also EmuTOS panic messages and MiNT
505: console output, not just normal BIOS console output.
506: .TP
507: .B \-\-disasm <x>
508: Set disassembly options. 'uae' and 'ext' select the dissasembly engine
509: to use, bitmask sets output options for the external disassembly engine
510: and 'help' lists them.
1.1.1.17! root 511: .TP
1.1.1.12 root 512: .B \-\-natfeats <bool>
513: Enable/disable (basic) Native Features support.
514: E.g. EmuTOS uses it for debug output.
1.1.1.4 root 515: .TP
1.1.1.13 root 516: .B \-\-trace <flags>
1.1.1.5 root 517: Activate debug traces, see
518: .B \-\-trace help
1.1.1.13 root 519: for available (comma separated) tracing flags
1.1.1.5 root 520: .TP
1.1.1.12 root 521: .B \-\-trace\-file <file>
1.1.1.8 root 522: Save trace output to <file> (default=stderr)
523: .TP
524: .B \-\-parse <file>
525: Parse/execute debugger commands from <file>
526: .TP
527: .B \-\-saveconfig
528: Save Hatari configuration and exit. Hatari UI needs Hatari configuration
529: file to start, this can be used to create it automatically.
530: .TP
1.1.1.12 root 531: .B \-\-no\-parachute
1.1.1.8 root 532: Disable SDL parachute to get Hatari core dumps. SDL parachute is enabled
533: by default to restore video mode in case Hatari terminates abnormally
534: while using non-standard screen resolution.
535: .TP
1.1.1.17! root 536: .B \-\-control\-socket <path>
! 537: Hatari connects to given local socket file and reads commands from it.
! 538: Use when the control process life-time is longer than Hatari's, or
! 539: control process needs response from Hatari
! 540: .TP
! 541: .B \-\-cmd\-fifo <path>
! 542: Hatari creates the indicated FIFO file and reads commands from it.
! 543: Commands can be echoed to FIFO file, and are same as with the control
! 544: socket. Hatari outputs help for unrecognized commands and subcommands
1.1.1.5 root 545: .TP
1.1.1.12 root 546: .B \-\-log\-file <file>
1.1.1.5 root 547: Save log output to <file> (default=stderr)
548: .TP
1.1.1.12 root 549: .B \-\-log\-level <x>
1.1.1.5 root 550: Log output level (x=debug/todo/info/warn/error/fatal)
551: .TP
1.1.1.12 root 552: .B \-\-alert\-level <x>
1.1.1.5 root 553: Show dialog for log messages above given level
1.1.1.7 root 554: .TP
1.1.1.12 root 555: .B \-\-run\-vbls <x>
1.1.1.7 root 556: Exit after X VBLs
1.1.1.16 root 557: .TP
558: .B \-\-benchmark
559: Start in benchmark mode (use with --run-vbls).
560: This allows to measure the speed of the emulation in frames per second
561: by running at maximum speed (don't wait for VBL). Disable audio/video
562: output to have as little OS overhead as possible
1.1.1.14 root 563:
564: .SH "INPUT HANDLING"
565: Hatari provides special input handling for different purposes.
566:
567: .SH "Emulated Atari ST joystick"
568: Joystick can be emulated either with keyboard or any real joystick
569: supported by your kernel / SDL library. First joystick button
570: acts as FIRE, second as SPACE key.
571:
572: .SH "Emulated Atari ST mouse"
573: Middle button mouse click is interpreted as double click, this
574: is especially useful in Fast Forward mode.
575: .PP
576: Mouse scrollwheel will act as cursor up and down keys.
577:
578: .SH "Emulated Atari ST keyboard"
579: Keys on the keyboard act as the normal Atari ST keys so pressing SPACE
580: on your PC will result in an emulated press of the SPACE key on the
581: ST. How the PC keys are mapped to Atari key codes, can be changed
582: with keyboard config file (-k option).
583: .PP
584: The following keys have special meanings:
585: .TP
586: .B Alt
587: will act as the ST's ALTERNATE key
588: .TP
589: .B left Ctrl
590: will act as the ST's CONTROL key
591: .TP
1.1.1.15 root 592: .B Print
1.1.1.14 root 593: will emulate the ST's HELP key
594: .TP
1.1.1.15 root 595: .B Scroll lock
1.1.1.14 root 596: will emulate the ST's UNDO key
597: .PP
598: .B AltGr
599: will act as
600: .B Alternate
601: as well as long as you do not press it together with a Hatari hotkey
602: combination.
603: .PP
1.1.1.17! root 604: The
1.1.1.14 root 605: .B right Ctrl
606: key is used as the fire button of the emulated joystick when you turn
1.1.1.17! root 607: on joystick emulation via keyboard.
1.1.1.14 root 608: .PP
609: The cursor keys will act as the cursor keys on the Atari ST as long as
610: joystick emulation via keyboard has been turned off.
611:
612: .SH "Keyboard shortcuts during emulation"
1.1.1.3 root 613: The shortcut keys can be configured in the configuration file.
614: The default settings are:
1.1 root 615: .TP
616: .B AltGr + a
617: record animation
618: .TP
619: .B AltGr + g
620: grab a screenshot
621: .TP
622: .B AltGr + i
623: boss key: leave full screen mode and iconify window
624: .TP
625: .B AltGr + m
626: (un-)lock the mouse into the window
627: .TP
628: .B AltGr + r
1.1.1.5 root 629: warm reset the ST (same as the reset button)
1.1 root 630: .TP
631: .B AltGr + c
1.1.1.5 root 632: cold reset the ST (same as the power switch)
633: .TP
634: .B AltGr + d
635: open dialog to select/change disk A
1.1 root 636: .TP
637: .B AltGr + s
638: enable/disable sound
639: .TP
640: .B AltGr + q
641: quit the emulator
642: .TP
643: .B AltGr + x
644: toggle normal/max speed
645: .TP
646: .B AltGr + y
647: enable/disable sound recording
648: .TP
1.1.1.4 root 649: .B AltGr + k
650: save memory snapshot
651: .TP
652: .B AltGr + l
653: load memory snapshot
654: .TP
1.1.1.14 root 655: .B AltGr + j
656: toggle joystick emulation via cursor keys
657: .TP
658: .B AltGr + F1
659: switch joystick type on joy port 0
660: .TP
661: .B AltGr + F2
662: switch joystick type on joy port 1
663: .TP
664: .B AltGr + F3
665: switch joystick type for joypad A
666: .TP
667: .B AltGr + F4
668: switch joystick type for joypad B
669: .TP
1.1.1.16 root 670: .B AltGr + b
671: toggle borders on/off
672: .TP
673: .B AltGr + f or F11
1.1 root 674: toggle between fullscreen and windowed mode
675: .TP
1.1.1.16 root 676: .B AltGr + o or F12
677: activate the Hatari options GUI
1.1 root 678: .br
679: You may need to hold SHIFT down while in windowed mode.
680: .TP
681: .B Pause
1.1.1.7 root 682: Pauses the emulation
683: .TP
684: .B AltGr + Pause
685: Invokes the internal Hatari debugger
1.1 root 686:
1.1.1.14 root 687: .SH "Keyboard shortcuts for the SDL GUI"
688: There are multiple ways to interact with the SDL GUI.
689: .PP
690: TAB and cursor keys change focus between UI elements. Additionally
691: Home key moves focus to first item, End key to last one. Initially
692: focus is on default UI element, but focus changes are remembered
693: between dialog invocations. Enter and Space invoke focused item. UI
694: elements with underlined characters can be invoked directly with Alt +
695: key with that character. Alt + arrow keys will act on arrow buttons.
696: .PP
697: Most importantly:
1.1 root 698: .TP
1.1.1.14 root 699: .B Options GUI main view
700: Enter accepts configuration, ESC cancels it.
1.1 root 701: .TP
1.1.1.14 root 702: .B Options GUI dialogs
703: Enter (or End+Enter if focus was moved) returns back to main view.
1.1 root 704: .TP
1.1.1.14 root 705: .B Fileselector
706: Page up and down keys scroll the file list. Enter on focused file
707: name selects it. Enter on OK button accepts the selected file. ESC
708: cancels the dialog/selection.
1.1 root 709: .TP
1.1.1.14 root 710: .B Alert dialogs
711: Enter accepts and ESC cancels the dialog.
1.1 root 712:
713: .SH "SEE ALSO"
714: The main program documentation, usually in /usr/share/doc/.
1.1.1.9 root 715: Among other things it contains an extensive usage manual,
1.1.1.14 root 716: software compatibility list and release notes.
1.1 root 717: .PP
1.1.1.16 root 718: The homepage of Hatari: http://hatari.tuxfamily.org/
1.1.1.9 root 719: .PP
720: Other Hatari programs and utilities:
721: .br
722: .IR hmsa (1),
723: .IR zip2st (1),
1.1.1.14 root 724: .IR atari\-convert\-dir (1),
725: .IR atari\-hd\-image (1),
1.1.1.9 root 726: .IR hatariui (1),
1.1.1.13 root 727: .IR hconsole (1),
728: .IR gst2ascii (1),
729: .IR hatari_profile (1)
1.1.1.14 root 730:
1.1.1.5 root 731: .SH "FILES AND DIRECTORIES"
1.1.1.3 root 732: .TP
733: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
1.1.1.5 root 734: The global configuration file of Hatari.
735: .TP
736: ~/.hatari/
737: The (default) directory for user's personal Hatari files;
738: .B hatari.cfg
739: (configuration file),
740: .B hatari.nvram
741: (NVRAM content file),
742: .B hatari.sav
743: (Hatari memory state snapshot file which Hatari can load/save automatically
744: when it starts/exits),
745: .B hatari.prn
746: (printer output file),
747: .B hatari.wav
748: (recorded sound output in WAV format),
749: .B hatari.ym
750: (recorded sound output in YM format).
1.1.1.3 root 751: .TP
1.1.1.5 root 752: /usr/share/hatari/ (or /usr/local/share/hatari/)
753: The global data directory of Hatari.
1.1.1.3 root 754: .TP
755: tos.img
756: The TOS ROM image will be loaded from the data directory of Hatari unless it
757: is specified on the command line or the configuration file.
758:
1.1 root 759: .SH "AUTHOR"
1.1.1.5 root 760: This manual page was written by Marco Herrn <[email protected]> for the
761: Debian project and later modified by Thomas Huth and Eero Tamminen to
762: 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.