--- hatari/doc/manual.html 2019/04/09 08:48:58 1.1.1.12 +++ hatari/doc/manual.html 2019/04/09 08:52:20 1.1.1.16 @@ -55,15 +55,15 @@

Hatari User's Manual

Index

@@ -84,7 +84,7 @@ Hatari on the WWW: Installation of the binary
  • Running Hatari for the first time -
  • Command line options +
  • Command line options and arguments
  • Using the emulated system
  • Performance
  • Appendix @@ -149,8 +153,8 @@ Hatari on the WWW:

    General description

    -Hatari is an Atari ST, STE, TT and Falcon emulator for Linux, FreeBSD, BeOS and -other Systems which are supported by the SDL library. +Hatari is an Atari ST, STE, TT and Falcon emulator for Linux, OSX, +Windows and other Systems which are supported by the SDL library. The emulator is open source software and is distributed under the terms of the GNU General Public License (GPL). @@ -166,18 +170,20 @@ Unlike many other Atari ST emulators whi environment for running GEM applications, Hatari tries to emulate the hardware of a ST as close as possible so that it is able to run most of the old ST games and demos. Of course you can run normal GEM applications with Hatari, too. -Recent versions of Hatari even feature basic STE, TT and Falcon emulation. +Recent versions of Hatari even feature STE, Falcon and basic TT emulation.

    Features

      -
    • 68000 - 68040 emulation via the UAE CPU core (no PMMU support though)
    • +
    • 68000 - 68040 emulation via the UAE CPU core + (MMU emulation only with the WinUAE CPU core)
    • ST RAM size variable (from 512kiB up to 14MiB are possible)
    • optional cartridge images for the ST ROM port
    • most of the ST specific hardware
    • ST Shifter with ST-High, ST-Medium and ST-Low resolutions, overscan effects for all borders in color resolutions
    • 512 color ST palette
    • +
    • Spec512 mode support for low and medium resolutions
    • many raster effects
    • scaling of low resolutions by factor two
    • interleaved lines rendering of ST-medium and (scaled) ST-low @@ -209,7 +215,7 @@ Recent versions of Hatari even feature b

      STE hardware emulation

      -There is support for following additional STE features: +

      There is support for following additional STE features:

      • horizontal and vertical hardware fine scrolling
      • split screen techniques / in-screen video address manipulations
      • @@ -223,7 +229,7 @@ There is support for following additiona

        Experimental TT hardware emulation

        -There is support for following additional TT features: +

        There is support for following additional TT features:

        • TT low/med/high resolution support
        • ST/TT palette switching and video shifter
        • @@ -233,9 +239,9 @@ There is support for following additiona

          Falcon hardware emulation

          -There is support for following additional Falcon features: +

          There is support for following additional Falcon features:

            -
          • Partial Videl emulation for all Falcon screen modes
          • +
          • Partial Videl and Videl borders emulation for all Falcon screen modes
          • Aspect correction and scaling of small resolutions by an integer factor
          • STE/Falcon palette switching and shifter
          • Mono/RGB/VGA/TV monitor types
          • @@ -257,7 +263,7 @@ to be affected by them.

            System requirements

            -

            Hatari currently has the following system requirements:

            +

            Hatari currently has the following minimum system requirements:

            • a fast PC (>500MHz, for Falcon and TT emulation even faster)
            • @@ -269,73 +275,87 @@ to be affected by them.

            -Certain versions of Hatari have successfully been tested by various people on +In the course of time Hatari has successfully been tested by various people on the following systems:

            • Linux/i86 with Kernel 2.4.x and 2.6.x
            • Linux/PPC with Kernel 2.4.x and 2.6.x
            • -
            • BeOS/i86
            • -
            • Apple PowerMac with Mac OS X
            • -
            • NetBSD 1.6
            • +
            • BeOS/i86
            • +
            • Apple Mac OS X on PowerPC and i86
            • +
            • NetBSD 1.6 on i86
            • NetBSD on a Digital Alpha
            • FreeBSD 4.1 on an i486, FreeBSD 4.8 on a Pentium 4 and FreeBSD 5.1
            • -
            • OpenBSD 3.5
            • +
            • OpenBSD 3.5 and 5.0
            • Solaris 8 on a SUN UltraSparc 1
            • Linux/ARM (oabi) on Sharp Zaurus SL-C760 PDA
            • Linux/ARM (eabi) on Nokia Maemo Internet Tablets and N900 phone
            • +
            • Windows XP

            Compiling and running

            Compiling Hatari

            -

            First, you need the SDL library, you can get it at: -http://www.libsdl.org/. Most -distributions already ship a suitable version. -Make sure to install the appropriate header files as well often called -"libsdl-dev" or the like. -

            -

            Second, you need the zLib compression library. You can get it from http://www.gzip.org/zlib/ -but the version shipped with your distribution will be sufficient in -most cases. Make sure to have the header files -for it installed as well. -

            -

            -For optional features like PNG format screenshots and Hatari window -embedding, you need to have the header files for libpng and libX11. -For Falcon microphone recording support portaudio library is needed. -

            -

            -Of course, you need the GNU C compiler and (GNU) Make, too! -

            -

            Change to the hatari/ directory, copy -Makefile-default.cnf to -Makefile.cnf and adapt the configuration file -to suite your system. Alternatively, you can use the supplied configure -script to auto-detect all parameters (type -"./configure --help" -to see the options of the script). -Don't forget to use some good CFLAGS for the compiler optimizations, e.g. -run configure in the following way: +

            Required:

            + + +

            Optional:

            +
              +
            • The PNG image library for PNG format screenshots and to +decrease AVI video recording file sizes. You can get it from +http://www.libpng.org/.
            • +
            • The GNU Readline library for Hatari debugger command line editing.
            • +
            • The Xlib library to support Hatari Python UI window embedding +on systems with the X window system (Linux and other unixes).
            • +
            • The portaudio library for Falcon microphone recording support
            • +
            +

            +The versions available in your Linux distribution will be sufficient +in most cases, but make sure you have also the header files installed +for the libraries as well! Typically they're in a corresponding -dev +package.

            + +

            +After you've verified that you have the required libraries and their +development files, change to the hatari/ +directory. Create a build/ directory under +it and configure the build system for your environment:

            -CFLAGS="-O3 -fomit-frame-pointer" ./configure
            +mkdir -p build
            +cd build
            +cmake ..
             

            Then compile Hatari by typing make. -If all -works fine, you'll get the executable hatari +If all works fine, you'll get the executable hatari in the src/ subdirectory.

            +

            +Note: Instead of calling CMake directly, you can also use the supplied +configure script to run CMake and to give the arguments (like install +prefix) in a format familiar from GNU Autotools using programs. Type +"./configure --help" +to see all the options supported by this script. +

            Installation of a TOS ROM

            Before you can start Hatari, you have to copy a TOS ROM image to the data -directory (the data directory is specified -in the configuration file Makefile.cnf) and +directory (<prefix>/share/hatari/, by +default /usr/local/share/hatari/) and rename it to tos.img, or use the --tos command line option to tell Hatari where to find a TOS ROM. @@ -363,12 +383,11 @@ select a TOS image file from the GUI.

            Installation of the binary

            -

            Type make install as root to do a -systemwide installation. In this case it is recommended -to set the DATADIR variable in Makefile.cnf to a proper value. /usr/local/share/hatari -is a good value in that case.

            -

            The Hatari executable should now be in your PATH and accessible from -anywhere.

            +

            Type make install as "root" user to +do a systemwide installation.

            +

            Assuming you didn't change the default installation prefix and that +/usr/local/bin/ is in your PATH, you should +be now able to start the Hatari executable from anywhere.

            When you finally have got a TOS image, try starting Hatari with the option --help to find out more about its command line parameters.

            @@ -384,13 +403,31 @@ to turn on the GUI to configure Hatari to suit your needs, press F11 to toggle windowed and fullscreen mode.

            -

            Command line options

            +

            Command line options +and arguments

            Usage:

            - hatari [options] [disk image name]
            + hatari [options] [disk image | directory | Atari program ]
             
            +

            As an argument one can give either a name of:

            +
              +
            • A floppy disk image, +
            • A directory that should be emulated as a virtual GEMDOS hard disk, or
            • +
            • An Atari program that should be autostarted. In this case + the program's directory will be used as the C: drive from + where this program will be started. + (Note that autostarting a program might not work if you've also + specified a floppy image for drive A: on command line or in config + file which contains a desktop.inf/newdesk.inf/emutos.inf file on + it.)
            • +
            + +

            Booting will be done from the disk image or directory that's given +last on the command line as an option or the argument (and which +corresponds to A: or C:).

            +

            Hatari command line options are split into several categories: