--- hatari/doc/manual.html 2019/04/09 08:49:50 1.1.1.13 +++ hatari/doc/manual.html 2019/04/09 08:52:20 1.1.1.16 @@ -55,15 +55,15 @@
-Version 1.5 +Version 1.6.2
Manual written by: Thomas Huth, Matthias Arndt & Eero Tamminen
-Hatari on the WWW: http://hatari.berlios.de/ +Hatari on the WWW: http://hatari.tuxfamily.org/
There is support for following additional Falcon features:
-Earlier 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:
| + | +Whether fullscreen mode uses desktop resolution to avoid: messing +multi-screen setups, several seconds delay needed by LCD monitors +resolution switching and the resulting sound break. As Hatari ST/E +display code doesn't support zooming (except low-rez doubling), it +doesn't get scaled (by Hatari or monitor) when this is enabled. +Therefore this is mainly useful only if you suffer from the described +effects, but still want to grab mouse and remove other distractions +from the screen just by toggling fullscreen mode. (disabled by default) + | +
| + | --spec512 <x> |
| +--force-max <bool> | +
| + | +Hatari window size is forced to specified maximum size and black borders +used when Atari resolution doesn't scale evenly to it. This is most +useful when recording videos of Falcon demos that change their +resolution. (disabled by default) + | +
| + | --aspect <bool> |
| -Whether to do monitor aspect ratio correction +Whether to do monitor aspect ratio correction (enabled by default) |
| -slow down FDC emulation (deprecated) +speed up FDC emulation (can cause incompatibilities) |
| + | +Load memory snap-shot <file> + | +
| + | -t, --tos <imagefile> |
| -Use ROM cartridge image <file> (only works if -GEMDOS HD emulation and extended VDI resolution are -disabled) +Use this option to enable/disable TOS ROM patching. Experts only! Leave +this enabled unless you know what you are doing! |
| ---memstate <file> | +--cartridge <imagefile>
| -Load memory snap-shot <file> +Use ROM cartridge image <file> (only works if +GEMDOS HD emulation and extended VDI resolution are +disabled) |
| + | +Patch redundantly high Timer-D frequency set by TOS. This about doubles +Hatari speed (for ST/e emulation) as the original Timer-D frequency causes +most of the interrupts. + | +
| + | +--fast-boot <bool> | +
| + | +Patch TOS and initialize the so-called "memvalid" system variables to +by-pass the memory test of TOS, so that the system boots faster. + | +
| + | +--rtc <bool> | +
| + | +Enable real-time clock + | +
| + | --mic <bool> |
| ---ym-mixing <x> | -
| - | -Select a method for mixing the three YM2149 voice volumes together. -"table" uses a lookup table of audio output voltage values measured -on STF and "linear" just averages the 3 YM voices. - | -
| - | ---timer-d <bool> | +--sound-sync <bool>
|
-Patch redundantly high Timer-D frequency set by TOS. This about doubles
-Hatari speed (for ST/e emulation) as the original Timer-D frequency causes
-most of the interrupts.
+The emulation rate is nudged by +100 or 0 or -100 micro-seconds on occasion.
+This prevents the sound buffer from overflowing (long latency and
+lost samples) or underflowing (short latency and repeated samples).
+The emulation rate smoothly deviates by a maximum of 0.58% until
+synchronized, while the emulator continuously generates every sound
+sample and the crystal controlled sound system consumes every sample.
+ (on|off, off is the default) |
| ---rtc <bool> | +--ym-mixing <x>
| -Enable real-time clock +Select a method for mixing the three YM2149 voice volumes together. +"model" uses a mathematical model of the YM voices, +"table" uses a lookup table of audio output voltage values measured +on STF and "linear" just averages the 3 YM voices. |
- Select if you want to use slow FDC (Floppy Disk Controller) emulation. - "Slow floppy access" is normally not required, except for some few - slideshows / intros which run too fast without this option. + Select if you want to use fast FDC (Floppy Disk Controller) emulation. + "Fast floppy access" will speed up disk accesses, but this could give + some incompatibilities with some programs that expect correct delays. + (some games/demos don't expect data to be read too fast from the disk)
You can choose if you want Hatari to write-protect your disks. Atari ST virii @@ -2134,12 +2239,15 @@ the screenshots and recorded videos.
+
Here you can control the sound subsystem.
-Check if you want emulated sound at all. Emulation is faster if +
Check "Enabled" if you want emulated sound at all. Emulation is faster if sound emulation is turned off.
+If you experiment latency issues with your OS audio's output, you +can check the "Synchronize" option to adjust Hatari's video emulation to match +your OS audio.
Nine frequencies from low to high quality are available. Experiment a little bit to find out which fits best for your setup. @@ -2149,8 +2257,10 @@ sound emulation is turned off.
the STE/TT/Falcon sound DMA.-YM voice volume mixing "ST table" method uses a lookup table of audio output -voltage values measured on STF and "Linear" just averages the 3 YM voices. +YM voices volume mixing "ST table" method uses a lookup table of audio output +voltage values measured on STF, "Math model" uses a complex model to mix the +3 YM voices and "Linear" just averages the 3 YM voices. Use "ST table" or "Math model" +for accurate sound's emulation.
You can select to record a piece of sound here. @@ -2512,8 +2622,10 @@ while the emulator is running.
On a 32-bit host system, the size of a hard disk image is limited to 2 GB. -On 64-bit host systems, bigger images might be possible but the support for -bigger images is not tested very well yet. +On 64-bit host systems, bigger images might be possible but the support +for bigger images is not tested very well yet. How large partition sizes +are supported inside the hard disk (images) depends on the TOS version. +TOS 1.0x supports up to 256MB partitions and TOS 4.0x up to 1GB ones.
@@ -2529,11 +2641,11 @@ length limit.If you provide --harddisk option -a directory containing only single letter subdirectories, each of -these subdirectories will be treated as a separate partition, otherwise -the given directory itself will be assigned to drive "C:". In the -multiple partition case, the letters used as the subdirectory names -will determine to which drives/partitions they're assigned. +a directory containing only single letter (C-Z) subdirectories, each +of these subdirectories will be treated as a separate partition, +otherwise the given directory itself will be assigned to drive "C:". +In the multiple partition case, the letters used as the subdirectory +names will determine to which drives/partitions they're assigned.
GEMDOS drive emulation is an easy way to share files between the @@ -2813,6 +2925,7 @@ Generic commands: cd ( ) : change directory evaluate ( e) : evaluate an expression help ( h) : print help + history (hi) : show last CPU & DSP PC values & executed instructions info ( i) : show machine/OS information lock ( ) : specify information to show on entering the debugger logfile ( f) : open or close log file @@ -2990,7 +3103,8 @@ You can load symbol name/address informa debugger with the "symbols" command (and with "dspsymbols" for DSP). These symbolic names can be used in arithmetic expressions and conditional breakpoint expressions. They also show up in the "disasm" -command output. +command output and you can trace calls to them with "trace cpu_symbols" +(and DSP symbols with "trace dsp_symbols").
The symbols file format is following:
@@ -3103,7 +3217,7 @@ a $1234 :2 Delete the breakpoint when it's hit i.e. trigger it only once. It may be useful if you just want to get a specific address. Or if you're on an instruction that jumps back to a start of the loop and you want to -finish the loop, you couuld use: +finish the loop, you could use:b pc > "pc" :once continue @@ -3259,8 +3373,8 @@ when you start a program.
-m data -m bss +m DATA +m BSS
-Hint: "info" command "aes", "gemdos" and "vdi" subcommands for can be -used to list the corresponding OS-call opcodes. For example, -to see the GEMDOS opcodes, use:
+Hint: "info" command "aes", "bios", "gemdos", "vdi" and "xbios" +subcommands for can be used to list the corresponding OS-call opcodes. +For example, to see the GEMDOS opcodes, use:info gemdos 1@@ -3383,7 +3489,7 @@ debugger prompt before continuing.
Disable tracing with "trace none" when you enter the debugger again. -"trace help" (or TAB) can be used to list all the (over 30) supported +"trace help" (or TAB) can be used to list all the (over 40) supported traceable things, from HW events to OS functions.
@@ -3398,9 +3504,8 @@ which tell it to intercept this higher l (which doesn't work under MiNT because it re-implements GEMDOS)
-If use of above isn't possible for the things you'd like to track, -you can use the OS call opcode breakpoints explained above with the -":trace" breakpoint option. +Unlike with AES and VDI tracing, BIOS, GEMDOS and XBIOS traces show +arguments for most of the calls.
Tracing options can be set even from a program within the emulation @@ -3413,6 +3518,11 @@ console. Note that the trace output file can be set only when Hatari starts, it cannot be changed from within the debugger (or emulation).
++If tracing isn't possible for the things you'd like to track, you can +use the OS call opcode breakpoints explained above with the ":trace" +breakpoint option. +
+history on +c +[breakpoint is hit and debugger entered] +history 16 ++
+history on +lock history 16 +c ++
@@ -3630,9 +3764,8 @@ Please see also @@ -3654,14 +3787,15 @@ DSP.Lastly, the debugger is much nicer to use with the command line -history, editing and especially with the command, command argument and -symbol name completion support. If you're building Hatari yourself, -please make sure that you have the GNU readline development files -installed (on Debian / Ubuntu these come from the libreadline5-dev -package). Otherwise completion doesn't get enabled when you configure -Hatari. +history, editing and especially the completion support for the +command, command argument and symbol names. +
++If you're building Hatari yourself, please make sure that you have the +GNU readline development files installed (on Debian / Ubuntu these +come from the libreadline5-dev package). Otherwise the name completion +and other features don't get enabled when you configure Hatari.
-ENABLE_TRACING define needs to be set for tracing to work. By default it should be enabled. @@ -3731,7 +3865,7 @@ an effect! Emulating the Falcon DSP is performance-wise several times more demanding than emulating the m68k; DSP runs at higher frequency, executes many instructions for each m68k instruction and emulation isn't as mature -and optimized. Unless some program needs DSP, none or +and optimized. Unless some Falcon program needs DSP, none or dummy DSP emulation mode could be used. Even of the programs that do use DSP, many use it only for background music and work fine without the real DSP emulation. @@ -3826,15 +3960,16 @@ to use zooming, disabling borders may he Handling Spec512 color modes which change the ST/e palette constantly takes some extra CPU. If you have problems with CPU usage in such screens and you care more e.g. from the sound quality than visuals, you -can disable the Spec512 mode handling by zeroing the threshold for that -with the --spec512 0 option. +can either increase the threshold or disable the Spec512 mode handling +completely by zeroing the threshold for that with the +--spec512 0 option.
Statusbar and drive LED
-If your version of libSDL uses VSync to synchronize the screen output, -drawing of the statusbar or the drive LED may have some minor impact -on performance too. Normally they shouldn't. +If your version of the SDL library uses VSync to synchronize the screen +output, drawing of the statusbar or the drive LED may have some minor +impact on performance too. Normally they shouldn't.
@@ -3863,13 +3998,13 @@ It depends on what you want to measure, disable sound and set high frame skip like --sound off --frameskips 60 so that the associated external overheads are minimized. E.g. video output -can on some platforms do VSync and measurements would then show -your monitor refresh frequency instead of actual Hatari performance. +can on some platforms do VSync and measurements would then show your +monitor refresh frequency instead of the actual Hatari performance.On Unix systems with times() function call, only the time spent by the Hatari process itself is measured. -On other systems much less accurate SDL "wall clock" timings are +On other systems, much less accurate SDL "wall clock" timings are used. To make latter more accurate you could use also --run-vbls option to specify how many VBLs Hatari should run before it exits. In this case it's best to @@ -3878,7 +4013,7 @@ given as memory snapshot to Hatari with the VBL count.
-Note that the numbers can fluctuate quite a bit, especially +Note that these numbers can fluctuate quite a bit, especially when the SDL timings are used, so for (statistically) reliable numbers you may need to repeat the measurement several times. You should of course make also sure that the system doesn't have any other activity @@ -3956,7 +4091,7 @@ parts of the emulated system is much tri src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" border="0" height="31" width="88">
- June 2011 + June 2012