Annotation of hatari/doc/hatari.1, revision 1.1.1.16

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
        !            28: work correctly with it.  For best compatibility, it's recommended to
        !            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       root       49: .TP 
                     50: .B \-h, \-\-help
1.1.1.4   root       51: Print command line options and terminate
1.1       root       52: .TP 
                     53: .B \-v, \-\-version
1.1.1.4   root       54: Print version information and terminate
                     55: .TP 
1.1.1.12  root       56: .B \-\-confirm\-quit <bool>
1.1.1.4   root       57: Whether Hatari confirms quitting
                     58: .TP 
                     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.5   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.16! root       69: .TP 
        !            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       root       78: .TP 
                     79: .B \-m, \-\-mono
1.1.1.4   root       80: Start in monochrome mode instead of color
                     81: .TP 
                     82: .B \-\-monitor <x>
                     83: Select monitor type (x = mono/rgb/vga/tv)
1.1       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.2   root       90: .TP 
                     91: .B \-w, \-\-window
1.1.1.13  root       92: Start the emulator in windowed mode
1.1       root       93: .TP 
1.1.1.7   root       94: .B \-\-grab
1.1.1.13  root       95: Grab mouse (also) in windowed mode
                     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.7   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.10  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.9   root      158: .TP 
                    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>
                    163: Wakeup State for MMU/GLUE (x=ws1/ws2/ws3/ws4/random, 
                    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.
                    174: .TP 
                    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.8   root      201: Use extended VDI resolution with width <w> (320 < w <= 1280)
1.1.1.10  root      202: .TP
1.1.1.4   root      203: .B \-\-vdi\-height <h>
1.1.1.8   root      204: Use extended VDI resolution with height <h> (200 < h <= 960)
1.1.1.14  root      205: 
1.1.1.9   root      206: .SH "Screen capture options"
                    207: .TP
                    208: .B \-\-crop <bool>
                    209: Remove statusbar from the screen captures
1.1.1.8   root      210: .TP
                    211: .B \-\-avirecord
1.1.1.14  root      212: Start AVI recording.  Note: recording will automatically
                    213: stop when emulation resolution changes.
1.1.1.8   root      214: .TP
1.1.1.12  root      215: .B \-\-avi\-vcodec <x>
1.1.1.14  root      216: Select AVI video codec (x = bmp/png).  PNG compression can
                    217: be \fImuch\fP slower than using the uncompressed BMP format,
                    218: but uncompressed video content takes huge amount of space.
                    219: .TP
                    220: .B \-\-png\-level <x>
                    221: Select PNG compression level for AVI video (x = 0-9).
                    222: Both compression efficiency and speed depend on the compressed
                    223: screen content. Highest compression level (9) can be \fIreally\fP
                    224: slow with some content. Levels 3-6 should compress nearly as well
                    225: with clearly smaller CPU overhead.
1.1.1.8   root      226: .TP
1.1.1.12  root      227: .B \-\-avi\-fps <x>
1.1.1.14  root      228: Force AVI frame rate (x = 50/60/71/...)
1.1.1.8   root      229: .TP
1.1.1.12  root      230: .B \-\-avi\-file <file>
1.1.1.14  root      231: Use <file> to record AVI
                    232: 
1.1.1.4   root      233: .SH "Devices options"
1.1       root      234: .TP 
1.1.1.4   root      235: .B \-j, \-\-joystick <port>
                    236: Emulate joystick with cursor keys in given port (0-5)
1.1       root      237: .TP 
1.1.1.5   root      238: .B \-\-joy<port> <type>
                    239: Set joystick type (none/keys/real) for given port
                    240: .TP 
1.1.1.4   root      241: .B \-\-printer <file>
                    242: Enable printer support and write data to <file>
1.1.1.2   root      243: .TP 
1.1.1.16! root      244: .B \-\-midi <bool>
        !           245: Whether to enable MIDI support (PortMidi only)
        !           246: .TP 
1.1.1.12  root      247: .B \-\-midi\-in <filename>
1.1.1.16! root      248: Enable MIDI support and write raw MIDI data to <file> (Linux only)
1.1       root      249: .TP 
1.1.1.12  root      250: .B \-\-midi\-out <filename>
1.1.1.16! root      251: Enable MIDI support and read raw MIDI data from <file> (Linux only)
1.1.1.6   root      252: .TP 
1.1.1.12  root      253: .B \-\-rs232\-in <filename>
1.1.1.6   root      254: Enable serial port support and use <file> as the input device
                    255: .TP 
1.1.1.12  root      256: .B \-\-rs232\-out <filename>
1.1.1.6   root      257: Enable serial port support and use <file> as the output device
1.1.1.14  root      258: 
                    259: .SH "Floppy drive options"
1.1.1.5   root      260: .TP
1.1.1.13  root      261: .B \-\-drive\-a <bool>
                    262: Enable/disable drive A (default is on)
                    263: .TP
                    264: .B \-\-drive\-b <bool>
                    265: Enable/disable drive B (default is on)
                    266: .TP
                    267: .B \-\-drive\-a\-heads <x>
                    268: Set number of heads for drive A (1=single sided, 2=double sided)
                    269: .TP
                    270: .B \-\-drive\-b\-heads <x>
                    271: Set number of heads for drive B (1=single sided, 2=double sided)
                    272: .TP
1.1.1.12  root      273: .B \-\-disk\-a <file>
1.1.1.5   root      274: Set disk image for floppy drive A
                    275: .TP
1.1.1.12  root      276: .B \-\-disk\-b <file>
1.1.1.5   root      277: Set disk image for floppy drive B
1.1.1.14  root      278: .TP 
                    279: .B \-\-fastfdc <bool>
                    280: speed up FDC emulation (can cause incompatibilities)
1.1.1.8   root      281: .TP
1.1.1.12  root      282: .B \-\-protect\-floppy <x>
1.1.1.8   root      283: Write protect floppy image contents (on/off/auto). With "auto" option
1.1.1.13  root      284: write protection is according to the disk image file attributes
1.1.1.14  root      285: 
                    286: .SH "Hard drive options"
                    287: .TP
                    288: .B \-d, \-\-harddrive <dir>
1.1.1.16! root      289: GEMDOS HD emulation.  Emulate harddrive partition(s) with <dir> contents.
        !           290: If directory contains only single letter (C-Z) subdirectories, each of these
1.1.1.14  root      291: subdirectories will be treated as a separate partition, otherwise the
                    292: given directory itself will be assigned to drive "C:". In the multiple
                    293: partition case, the letters used as the subdirectory names will
                    294: determine to which drives/partitions they're assigned. If <dir> is
                    295: an empty string, then harddrive's emulation is disabled
1.1.1.8   root      296: .TP
1.1.1.12  root      297: .B \-\-protect\-hd <x>
1.1.1.8   root      298: Write protect harddrive <dir> contents (on/off/auto). With "auto" option
                    299: the protection can be controlled by setting individual files attributes
                    300: as it disables the file attribute modifications for the GEMDOS hard disk
1.1.1.13  root      301: emulation
1.1.1.12  root      302: .TP
                    303: .B \-\-gemdos\-case <x>
                    304: Specify whether new dir/filenames are forced to be in upper or lower case
1.1.1.13  root      305: with the GEMDOS HD emulation. Off/upper/lower, off by default
1.1.1.10  root      306: .TP
1.1.1.16! root      307: .B \-\-gemdos\-time <x>
        !           308: Specify what file modification timestamps should be used, emulation
        !           309: internal (atari) ones, or ones from the machine (host) on which the
        !           310: machine is running. While Atari emulation and host clocks are in sync
        !           311: at Hatari startup, they will diverge while emulation is running,
        !           312: especially if you use fast forward.  Default is "atari".  If you
        !           313: modify files accessed by the Atari side, directly from the host side
        !           314: while Hatari is already running, you may want to use "host" option
        !           315: .TP
1.1.1.14  root      316: .B \-\-gemdos\-conv <bool>
                    317: Whether GEMDOS file names with 8-bit (non-ASCII) characters are
                    318: converted between Atari and host character sets. On Linux, host file
                    319: name character set is assumed to be UTF-8. This option is disabled by
                    320: default, in case you've transferred files from Atari machine without
                    321: proper file name conversion (e.g. by zipping them on Atari and
1.1.1.16! root      322: unzipping on PC)
        !           323: .TP
        !           324: .B \-\-gemdos\-drive <drive>
        !           325: Assign (seprately specified) GEMDOS HD to given drive letter (C-Z)
        !           326: instead of default C:, or use "skip" to specify that Hatari should
        !           327: add GEMDOS HD after IDE and ACSI drives (assumes Hatari and native
        !           328: HD driver parse same number of partitions from HD images partition
        !           329: tables)
1.1.1.14  root      330: .TP
                    331: .B \-\-acsi <id>=<file>
                    332: Emulate an ACSI hard disk with given BUS ID (0-7) using image <file>.
1.1.1.16! root      333: If just filename is given, it's assigned to BUS ID 0
1.1.1.5   root      334: .TP 
1.1.1.8   root      335: .B \-\-ide\-master <file>
                    336: Emulate an IDE master hard disk with an image <file>
                    337: .TP 
                    338: .B \-\-ide\-slave <file>
                    339: Emulate an IDE slave hard disk with an image <file>
1.1.1.14  root      340: 
1.1.1.4   root      341: .SH "Memory options"
1.1       root      342: .TP 
1.1.1.10  root      343: .B \-\-memstate <file>
                    344: Load memory snap-shot <file>
                    345: .TP 
1.1.1.4   root      346: .B \-s, \-\-memsize <x>
1.1.1.16! root      347: Set amount of emulated ST RAM, x = 1 to 14 MiB, or 0 for 512 KiB.
        !           348: Other values are considered as a size in KiB
1.1.1.14  root      349: .TP
                    350: .B \-s, \-\-ttram <x>
                    351: Set amount of emulated TT RAM, x = 0 to 256 MiB (in 4MB steps)
                    352: 
1.1.1.10  root      353: .SH "ROM options"
1.1       root      354: .TP 
1.1.1.4   root      355: .B \-t, \-\-tos <imagefile>
                    356: Specify TOS ROM image to use
1.1       root      357: .TP 
1.1.1.12  root      358: .B \-\-patch\-tos <bool>
1.1.1.10  root      359: Use this option to enable/disable TOS ROM patching. Experts only! Leave
                    360: this enabled unless you know what you are doing!
                    361: .TP 
1.1.1.4   root      362: .B \-\-cartridge <imagefile>
                    363: Use ROM cartridge image <file> (only works if GEMDOS HD emulation and
                    364: extended VDI resolution are disabled)
1.1.1.14  root      365: 
1.1.1.15  root      366: .SH "Common CPU options"
1.1.1.4   root      367: .TP 
                    368: .B \-\-cpulevel <x>
                    369: Specify CPU (680x0) to use (use x >= 1 with EmuTOS or TOS >= 2.06 only!)
                    370: .TP 
                    371: .B \-\-cpuclock <x>
                    372: Set the CPU clock (8, 16 or 32 Mhz)
                    373: .TP 
                    374: .B \-\-compatible <bool>
1.1.1.9   root      375: Use a more compatible, but slower 68000 CPU mode with
                    376: better prefetch accuracy and cycle counting
1.1.1.14  root      377: 
1.1.1.15  root      378: .SH "WinUAE CPU core options"
                    379: .TP
                    380: .B \-\-cpu\-exact <bool>
                    381: Use cycle exact CPU emulation (cache emulation)
                    382: .TP
                    383: .B \-\-addr24 <bool>
                    384: Use 24-bit instead of 32-bit addressing mode
                    385: (24-bit is enabled by default)
                    386: .TP
                    387: .B \-\-fpu <x>
                    388: FPU type (x=none/68881/68882/internal)
                    389: .TP
                    390: .B \-\-mmu <bool>
                    391: Use MMU emulation
                    392: 
1.1.1.4   root      393: .SH "Misc system options"
1.1.1.3   root      394: .TP 
                    395: .B \-\-machine <x>
1.1.1.16! root      396: Select machine type (x = st, megast, ste, megaste, tt or falcon)
1.1.1.4   root      397: .TP 
                    398: .B \-\-blitter <bool>
1.1.1.5   root      399: Enable blitter emulation (ST only)
1.1.1.4   root      400: .TP 
                    401: .B \-\-dsp <x>
1.1.1.5   root      402: Falcon DSP emulation (x = none, dummy or emu, Falcon only)
1.1.1.4   root      403: .TP 
1.1.1.12  root      404: .B \-\-timer\-d <bool>
1.1.1.10  root      405: Patch redundantly high Timer-D frequency set by TOS.  This about doubles
                    406: Hatari speed (for ST/e emulation) as the original Timer-D frequency causes
                    407: most of the interrupts.
                    408: .TP
1.1.1.12  root      409: .B \-\-fast\-boot <bool>
1.1.1.10  root      410: Patch TOS and initialize the so-called "memvalid" system variables to by-pass
                    411: the memory test of TOS, so that the system boots faster.
1.1.1.14  root      412: 
1.1.1.10  root      413: .SH "Sound options"
                    414: .TP 
1.1.1.9   root      415: .B \-\-mic <bool>
                    416: Enable/disable (Falcon only) microphone
                    417: .TP 
1.1.1.4   root      418: .B \-\-sound <x>
1.1.1.7   root      419: Sound frequency: 6000-50066. "off" disables the sound and speeds up
                    420: the emulation. To prevent extra sound artifacts, the frequency should be
                    421: selected so that it either matches evenly with the STE/TT/Falcon sound
                    422: DMA (6258, 12517, 250033, 50066 Hz) or your sound card frequencies
                    423: (11025, 22050, 44100 or 6000...48000 Hz).  Check what your sound card
                    424: supports.
1.1.1.8   root      425: .TP 
1.1.1.12  root      426: .B \-\-sound\-buffer\-size <x>
1.1.1.9   root      427: SDL's sound buffer size: 10-100, or 0 to use default buffer size.
1.1.1.8   root      428: By default Hatari uses an SDL buffer size of 1024 samples, which
                    429: gives approximatively 20-30 ms of sound depending on the chosen sound
                    430: frequency. Under some OS or with not fully supported sound card, this
                    431: default setting can cause a bigger delay at lower frequency (nearly 0.5 sec).
                    432: In that case, you can use this option to force the size of the sound
                    433: buffer to a fixed number of milliseconds of sound (using 20 is often
                    434: a good choice if you have such problems). Most users will not need this option.
1.1.1.9   root      435: .TP 
1.1.1.12  root      436: .B \-\-sound\-sync <bool>
                    437: The emulation rate is nudged by +100 or 0 or \-100 micro-seconds on occasion.
1.1.1.11  root      438: This prevents the sound buffer from overflowing (long latency and
                    439: lost samples) or underflowing (short latency and repeated samples).
                    440: The emulation rate smoothly deviates by a maximum of 0.58% until
                    441: synchronized, while the emulator continuously generates every sound
                    442: sample and the crystal controlled sound system consumes every sample.
                    443: .br
                    444: (on|off, off=default)
                    445: .TP 
1.1.1.12  root      446: .B \-\-ym\-mixing <x>
1.1.1.9   root      447: Select a method for mixing the three YM2149 voice volumes together.
1.1.1.10  root      448: "model" uses a mathematical model of the YM voices,
1.1.1.9   root      449: "table" uses a lookup table of audio output voltage values measured
                    450: on STF and "linear" just averages the 3 YM voices.
1.1.1.14  root      451: 
1.1.1.4   root      452: .SH "Debug options"
1.1.1.14  root      453: .TP
                    454: .B \-W, \-\-wincon
                    455: Open console window (Windows only)
1.1.1.4   root      456: .TP 
1.1.1.7   root      457: .B \-D, \-\-debug
                    458: Toggle whether CPU exceptions invoke the debugger
1.1.1.5   root      459: .TP 
1.1.1.13  root      460: .B \-\-debug\-except <flags>
                    461: Specify which exceptions invoke debugger, see
                    462: .B \-\-debug\-except help
                    463: for available (comma separated) exception flags.
1.1.1.12  root      464: .TP 
1.1.1.13  root      465: .B \-\-bios\-intercept
                    466: Toggle XBios command parsing. Allows Atari programs to use all Hatari
                    467: functionality and change Hatari state through Hatari specifit
                    468: XBios(255) calls. XBios(20) printscreen calls produce also Hatari
                    469: screenshots.
                    470: .TP
1.1.1.12  root      471: .B \-\-conout <device>
                    472: Enable console (xconout vector functions) output redirection for given
                    473: <device> to host terminal.  Device 2 is for the (CON:) VT52 console,
                    474: which vector function catches also EmuTOS panic messages and MiNT
                    475: console output, not just normal BIOS console output.
                    476: .TP
                    477: .B \-\-disasm <x>
                    478: Set disassembly options.  'uae' and 'ext' select the dissasembly engine
                    479: to use, bitmask sets output options for the external disassembly engine
                    480: and 'help' lists them.
                    481: .TP 
                    482: .B \-\-natfeats <bool>
                    483: Enable/disable (basic) Native Features support.
                    484: E.g. EmuTOS uses it for debug output.
1.1.1.4   root      485: .TP
1.1.1.13  root      486: .B \-\-trace <flags>
1.1.1.5   root      487: Activate debug traces, see
                    488: .B \-\-trace help
1.1.1.13  root      489: for available (comma separated) tracing flags
1.1.1.5   root      490: .TP
1.1.1.12  root      491: .B \-\-trace\-file <file>
1.1.1.8   root      492: Save trace output to <file> (default=stderr)
                    493: .TP
                    494: .B \-\-parse <file>
                    495: Parse/execute debugger commands from <file>
                    496: .TP
                    497: .B \-\-saveconfig
                    498: Save Hatari configuration and exit. Hatari UI needs Hatari configuration
                    499: file to start, this can be used to create it automatically.
                    500: .TP
1.1.1.12  root      501: .B \-\-no\-parachute
1.1.1.8   root      502: Disable SDL parachute to get Hatari core dumps. SDL parachute is enabled
                    503: by default to restore video mode in case Hatari terminates abnormally
                    504: while using non-standard screen resolution.
                    505: .TP
1.1.1.12  root      506: .B \-\-control\-socket <file>
1.1.1.5   root      507: Hatari reads options from given socket at run-time
                    508: .TP
1.1.1.12  root      509: .B \-\-log\-file <file>
1.1.1.5   root      510: Save log output to <file> (default=stderr)
                    511: .TP
1.1.1.12  root      512: .B \-\-log\-level <x>
1.1.1.5   root      513: Log output level (x=debug/todo/info/warn/error/fatal)
                    514: .TP
1.1.1.12  root      515: .B \-\-alert\-level <x>
1.1.1.5   root      516: Show dialog for log messages above given level
1.1.1.7   root      517: .TP
1.1.1.12  root      518: .B \-\-run\-vbls <x>
1.1.1.7   root      519: Exit after X VBLs
1.1.1.16! root      520: .TP
        !           521: .B \-\-benchmark
        !           522: Start in benchmark mode (use with --run-vbls).
        !           523: This allows to measure the speed of the emulation in frames per second
        !           524: by running at maximum speed (don't wait for VBL). Disable audio/video
        !           525: output to have as little OS overhead as possible
1.1.1.14  root      526: 
                    527: .SH "INPUT HANDLING"
                    528: Hatari provides special input handling for different purposes.
                    529: 
                    530: .SH "Emulated Atari ST joystick"
                    531: Joystick can be emulated either with keyboard or any real joystick
                    532: supported by your kernel / SDL library.  First joystick button
                    533: acts as FIRE, second as SPACE key.
                    534: 
                    535: .SH "Emulated Atari ST mouse"
                    536: Middle button mouse click is interpreted as double click, this
                    537: is especially useful in Fast Forward mode.
                    538: .PP
                    539: Mouse scrollwheel will act as cursor up and down keys.
                    540: 
                    541: .SH "Emulated Atari ST keyboard"
                    542: Keys on the keyboard act as the normal Atari ST keys so pressing SPACE
                    543: on your PC will result in an emulated press of the SPACE key on the
                    544: ST. How the PC keys are mapped to Atari key codes, can be changed
                    545: with keyboard config file (-k option).
                    546: .PP
                    547: The following keys have special meanings:
                    548: .TP
                    549: .B  Alt
                    550: will act as the ST's ALTERNATE key
                    551: .TP
                    552: .B  left Ctrl
                    553: will act as the ST's CONTROL key
                    554: .TP
1.1.1.15  root      555: .B  Print
1.1.1.14  root      556: will emulate the ST's HELP key
                    557: .TP
1.1.1.15  root      558: .B  Scroll lock
1.1.1.14  root      559: will emulate the ST's UNDO key
                    560: .PP
                    561: .B AltGr
                    562: will act as
                    563: .B Alternate
                    564: as well as long as you do not press it together with a Hatari hotkey
                    565: combination.
                    566: .PP
                    567: The 
                    568: .B right Ctrl
                    569: key is used as the fire button of the emulated joystick when you turn
                    570: on joystick emulation via keyboard. 
                    571: .PP
                    572: The cursor keys will act as the cursor keys on the Atari ST as long as
                    573: joystick emulation via keyboard has been turned off.
                    574: 
                    575: .SH "Keyboard shortcuts during emulation"
1.1.1.3   root      576: The shortcut keys can be configured in the configuration file.
                    577: The default settings are:
1.1       root      578: .TP
                    579: .B AltGr + a
                    580: record animation
                    581: .TP
                    582: .B AltGr + g
                    583: grab a screenshot
                    584: .TP
                    585: .B AltGr + i
                    586: boss key: leave full screen mode and iconify window
                    587: .TP
                    588: .B AltGr + m
                    589: (un-)lock the mouse into the window
                    590: .TP
                    591: .B AltGr + r
1.1.1.5   root      592: warm reset the ST (same as the reset button)
1.1       root      593: .TP
                    594: .B AltGr + c
1.1.1.5   root      595: cold reset the ST (same as the power switch)
                    596: .TP
                    597: .B AltGr + d
                    598: open dialog to select/change disk A
1.1       root      599: .TP
                    600: .B AltGr + s
                    601: enable/disable sound
                    602: .TP
                    603: .B AltGr + q
                    604: quit the emulator
                    605: .TP
                    606: .B AltGr + x
                    607: toggle normal/max speed
                    608: .TP
                    609: .B AltGr + y
                    610: enable/disable sound recording
                    611: .TP
1.1.1.4   root      612: .B AltGr + k
                    613: save memory snapshot
                    614: .TP
                    615: .B AltGr + l
                    616: load memory snapshot
                    617: .TP
1.1.1.14  root      618: .B AltGr + j
                    619: toggle joystick emulation via cursor keys
                    620: .TP
                    621: .B AltGr + F1
                    622: switch joystick type on joy port 0
                    623: .TP
                    624: .B AltGr + F2
                    625: switch joystick type on joy port 1
                    626: .TP
                    627: .B AltGr + F3
                    628: switch joystick type for joypad A
                    629: .TP
                    630: .B AltGr + F4
                    631: switch joystick type for joypad B
                    632: .TP
1.1.1.16! root      633: .B AltGr + b
        !           634: toggle borders on/off
        !           635: .TP
        !           636: .B AltGr + f or F11
1.1       root      637: toggle between fullscreen and windowed mode
                    638: .TP
1.1.1.16! root      639: .B AltGr + o or F12
        !           640: activate the Hatari options GUI
1.1       root      641: .br
                    642: You may need to hold SHIFT down while in windowed mode.
                    643: .TP
                    644: .B Pause
1.1.1.7   root      645: Pauses the emulation
                    646: .TP
                    647: .B AltGr + Pause
                    648: Invokes the internal Hatari debugger
1.1       root      649: 
1.1.1.14  root      650: .SH "Keyboard shortcuts for the SDL GUI"
                    651: There are multiple ways to interact with the SDL GUI.
                    652: .PP
                    653: TAB and cursor keys change focus between UI elements.  Additionally
                    654: Home key moves focus to first item, End key to last one.  Initially
                    655: focus is on default UI element, but focus changes are remembered
                    656: between dialog invocations. Enter and Space invoke focused item. UI
                    657: elements with underlined characters can be invoked directly with Alt +
                    658: key with that character.  Alt + arrow keys will act on arrow buttons.
                    659: .PP
                    660: Most importantly:
1.1       root      661: .TP
1.1.1.14  root      662: .B Options GUI main view
                    663: Enter accepts configuration, ESC cancels it.
1.1       root      664: .TP
1.1.1.14  root      665: .B Options GUI dialogs
                    666: Enter (or End+Enter if focus was moved) returns back to main view.
1.1       root      667: .TP
1.1.1.14  root      668: .B Fileselector
                    669: Page up and down keys scroll the file list.  Enter on focused file
                    670: name selects it.  Enter on OK button accepts the selected file. ESC
                    671: cancels the dialog/selection.
1.1       root      672: .TP
1.1.1.14  root      673: .B Alert dialogs
                    674: Enter accepts and ESC cancels the dialog.
1.1       root      675: 
                    676: .SH "SEE ALSO"
                    677: The main program documentation, usually in /usr/share/doc/.
1.1.1.9   root      678: Among other things it contains an extensive usage manual,
1.1.1.14  root      679: software compatibility list and release notes.
1.1       root      680: .PP
1.1.1.16! root      681: The homepage of Hatari: http://hatari.tuxfamily.org/
1.1.1.9   root      682: .PP
                    683: Other Hatari programs and utilities:
                    684: .br
                    685: .IR hmsa (1),
                    686: .IR zip2st (1),
1.1.1.14  root      687: .IR atari\-convert\-dir (1),
                    688: .IR atari\-hd\-image (1),
1.1.1.9   root      689: .IR hatariui (1),
1.1.1.13  root      690: .IR hconsole (1),
                    691: .IR gst2ascii (1),
                    692: .IR hatari_profile (1)
1.1.1.14  root      693: 
1.1.1.5   root      694: .SH "FILES AND DIRECTORIES"
1.1.1.3   root      695: .TP
                    696: /etc/hatari.cfg (or /usr/local/etc/hatari.cfg)
1.1.1.5   root      697: The global configuration file of Hatari.
                    698: .TP
                    699: ~/.hatari/
                    700: The (default) directory for user's personal Hatari files;
                    701: .B hatari.cfg
                    702: (configuration file),
                    703: .B hatari.nvram
                    704: (NVRAM content file),
                    705: .B hatari.sav
                    706: (Hatari memory state snapshot file which Hatari can load/save automatically
                    707: when it starts/exits),
                    708: .B hatari.prn
                    709: (printer output file),
                    710: .B hatari.wav
                    711: (recorded sound output in WAV format),
                    712: .B hatari.ym
                    713: (recorded sound output in YM format).
1.1.1.3   root      714: .TP
1.1.1.5   root      715: /usr/share/hatari/ (or /usr/local/share/hatari/)
                    716: The global data directory of Hatari.
1.1.1.3   root      717: .TP
                    718: tos.img
                    719: The TOS ROM image will be loaded from the data directory of Hatari unless it
                    720: is specified on the command line or the configuration file.
                    721: 
1.1       root      722: .SH "AUTHOR"
1.1.1.5   root      723: This manual page was written by Marco Herrn <[email protected]> for the
                    724: Debian project and later modified by Thomas Huth and Eero Tamminen to
                    725: suit the latest version of Hatari.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.