Annotation of uae/docs/README, revision 1.1.1.2

1.1.1.2 ! root        1: This is version 0.6.8 of UAE, the Un*x Amiga Emulator.
1.1       root        2: 
                      3: #include <drivel.h>
                      4: 
                      5: Copyright 1995, 1996 Bernd Schmidt & contributors (see below). This program is
                      6: freeware. You may do whatever you want with it for personal use.
                      7: Permission is granted to redistribute this program free of charge, provided it 
                      8: is distributed in the full archive with unmodified contents and no profit 
                      9: beyond the price of the media on which it is distributed is made. Exception to
                     10: the last rule: It may be included on freeware/shareware collections on CD-ROM.
                     11: There are no warranties of any kind for this program. If you use this program,
                     12: you do so at your own risk. The authors are not responsible for any damages 
                     13: that might result from using this program.
1.1.1.2 ! root       14: "Amiga" is a registered trademark of Commodore, Inc. Other trademarks
        !            15: mentioned in this document are property of their owners.
1.1       root       16: 
                     17: 
                     18: Overview
                     19: ========
                     20: 
1.1.1.2 ! root       21: An emulator is a program which enables you to run software for a machine
        !            22: which has non-native hardware and a non-native operating system, on your
        !            23: computer.  UAE allows you to run most of the available Amiga software. It is a
        !            24: software emulation, meaning that no extra or special hardware is needed to do
        !            25: this. The hardware of an Amiga is emulated accurately, so that Amiga software
        !            26: is tricked into thinking it is running on the real thing, with your computer's
        !            27: display, keyboard, harddisk and mouse taking the parts of their emulated
        !            28: counterparts.
1.1       root       29: 
                     30: UAE was developed for Unixoid systems. Meanwhile, it has been ported to the
1.1.1.2 ! root       31: Mac, DOS, the BeBox, NextStep, the XFree86/OS2 environment and the Amigas (it
        !            32: can run itself by now). You should have received several other files along
        !            33: with this document with details on how to install and use the version for your
        !            34: operating system.
1.1       root       35: 
                     36: This section is just what it says: an overview. Please read _all_ of this
1.1.1.2 ! root       37: file, especially if you have problems. UAE has many, many features and
        !            38: equally many configuration options. If you don't know about them, it's likely
        !            39: that UAE doesn't work for you, or doesn't work as good as it could.
        !            40: 
        !            41: Please read also the file "FAQ" which contains some Frequently Asked
        !            42: Questions (and even the answers!) System-specific documents like "README.UNIX"
        !            43: and "README.DOS" also exist, you should read the appropriate one, too.
        !            44: 
        !            45: People have complained that the UAE documentation contains only "weird jargon".
        !            46: Sorry about this. Despite what MessySoft and Tomato tell you, computer
        !            47: programs aren't always easy to use. UAE does require some assistance from you,
        !            48: and therefore you should at least understand a bit about computers. After all,
        !            49: you are an Amiga fan, so you should know what a Workbench is, don't you think?
1.1       root       50: 
                     51: 
1.1.1.2 ! root       52: Features
        !            53: ========
        !            54: 
        !            55: This version of UAE emulates:
1.1       root       56: 
1.1.1.2 ! root       57: - An Amiga 500 Computer, with 68000 or 68020 CPU (68020 includes 68881 FPU)
        !            58: - OCS Graphics Chipset, plus big blits from the ECS Chipset
        !            59: - Up to 2MB Chip RAM
        !            60: - Up to 8MB Fast RAM
        !            61: - Up to 1MB Slow RAM, for extended compatability with problem software
        !            62: - 4 x 3.5" floppy disk drives (DF0:, DF1:, DF2: and DF3:)
        !            63: - Hard-disk emulation
        !            64: - Joystick support (with option of mapping joystick to numeric keypad)
        !            65: - Mouse support
        !            66: - Ability to run in various screen modes (for better display quality or
        !            67:   better speed)
        !            68: - Full sound support, consisting of 4 x 8bit channels (mixed into one, so
        !            69:   output is mono for now).
        !            70: - Beta parallel port support
        !            71: - some other things which don't work well enough to mention them here...
        !            72: 
        !            73:   
        !            74: Requirements (IMPORTANT! READ THIS!)/Limitations
        !            75: ================================================
        !            76: 
        !            77: Not emulated:
        !            78: - Sprite collisions
        !            79: - a MMU (part of 68030/040 CPUs except those that Commodore used). This means
        !            80:   you can't use virtual memory systems or real operating systems like Linux
        !            81:   or BSD.
        !            82: - The AGA chipset (A4000/A1200). This chipset has enhanced capabilites for
        !            83:   up to 256 colors in all resolutions.
        !            84: - Serial port emulation exists but doesn't work too well.
        !            85: 
        !            86: Since the PC floppy controller can't read Amiga disks (yes, that's a fact), 
        !            87: floppy access has to be emulated differently: Floppies are emulated by means 
        !            88: of disk files that contain a raw image of the floppy disk you want to emulate.
        !            89: A disk file is an image of the raw data on an Amiga floppy disk, it contains
        !            90: 901120 bytes (880K), which is the standard capacity of an Amiga disk.
        !            91: 
        !            92: To actually run the program, you'll need to install the ROM image from your
        !            93: Amiga. You can't run UAE if you don't have this image. It is not included
        !            94: because it is copyrighted software. Don't ask me to send you one. I won't.
        !            95: If you don't have an Amiga and still want to use UAE, you'll have to buy an
        !            96: Amiga or at least the system software (ROM + Workbench) first.
        !            97: The Kickstart image can have a size of either 256K or 512K. It must be named
        !            98: "kick.rom" by default.
        !            99: 
        !           100: Read the section "tools" below for information how to create ROM images and
        !           101: disk files.
1.1       root      102: 
                    103: If you don't have a Kickstart file, you may still be able to boot some games
                    104: and demos. The emulator includes some primitive bootstrap code that will try
                    105: to read and execute the bootblock of the diskfile you are using, and if that
                    106: bootblock only uses the one or two Kickstart functions that are supported by 
                    107: the "replacement Kickstart", your program will boot. Don't expect too much, 
                    108: though.
                    109: 
1.1.1.2 ! root      110: You'll also need some other software to run - why else would you want to
        !           111: emulate an Amiga? There are several ways to make the software accessible to
        !           112: UAE, either with disk image files or with a harddisk emulation.You should make
        !           113: an image of your Amiga's Workbench disk and install it as "df0.adf" (adf =
        !           114: Amiga Disk File) when you use UAE for the first time. More about how to create
        !           115: these files in the chapter "Transferring software"
1.1       root      116: 
                    117: 
                    118: Invoking UAE
                    119: ============
                    120: 
1.1.1.2 ! root      121: First, read the system-specific documents for information how to set up UAE.
        !           122: You should have an executable program called "uae". You can simply execute it,
        !           123: but you can also optionally give it one of the following
1.1       root      124: parameters:
                    125: 
                    126: General options:
                    127:  -h      : Give help on the options.
1.1.1.2 ! root      128:  -A n    : Set emulator accuracy to n. The default is n = 2, which means the
        !           129:            emulator will try to be as accurate as possible. This no longer
        !           130:           does much in this version, and I'll probably remove it.
1.1       root      131:  -f n    : Sets the frame rate to 1/n. Only every nth screen will be drawn.
                    132:  -a      : Add no expansion devices. This will disable fastmem and harddisk
                    133:            emulation, but some extremely badly-written games may need this.
1.1.1.2 ! root      134:           (Kickstart 1.2 apparently needs it, too)
1.1       root      135:  -l lang : Set the keyboard language. Currently, the following values can be 
                    136:           used for lang: "us" for U.S. keyboard (default), "se" for swedish, 
                    137:           "fr" for french, "it" for italian  or "de" for german keyboard.
                    138:  -0 file : Try to use file as diskfile for drive 0 instead of df0.adf.
                    139:            -1 file, -2 file and -3 also exist for the other drives.
                    140:  -r file : Use file instead of kick.rom as Kickstart image.
                    141:  -J      : Use the numeric pad for joystick emulation (with 5 and 0 as fire 
                    142:            buttons). This will turn off real joystick support. It's no good 
                    143:           for action games, but may be useful for other games.
                    144:  -x      : General-purpose option. For the X version, it makes the X cursor 
                    145:            visible (recommended). For the SVGAlib version, it turns off
1.1.1.2 ! root      146:           linear framebuffer support.
1.1       root      147:  -o      : Allow UAE to overwrite ~/.uaerc with the selected options. This is
1.1.1.2 ! root      148:            only used by the text-based user interface in the SVGAlib and DOS
        !           149:           versions.
1.1       root      150:  -G      : Disable the user interface (if present).
1.1.1.2 ! root      151:  -n specs: Set blitter emulation. specs is a string of characters. If it
        !           152:            contains a "3", the blitter will use 32 bit operations where that
        !           153:           seems profitable (note that this will cause bus errors on most
        !           154:           RISC machines). If you specify "i", all blits will finish 
        !           155:           immediately, which can be nice for speed. To enable both options,
        !           156:           say "-n 3i"
1.1       root      157: 
                    158: Emulating external devices (harddisk, printer, serial port):
                    159:  -M VOLUME:path
                    160:  -m VOLUME:path
                    161:            mount the unix file system at path as an Amiga filesystem with
                    162:           volume name "VOLUME:". For example, "-M sound:/usr/amiga/modules"
                    163:           If you use -M instead of -m, the volume will be read only.
                    164:           See below.
                    165:  -p cmd  : Enable printing. See below.
                    166:  -I dev  : Use "dev" as serial device (e.g. /dev/ttyS1 on Linux). Doesn't
                    167:            really work yet, at least not for me.
                    168: 
                    169: Sound options:
                    170:  -S n    : If your version of UAE supports sound, set the sound support level
                    171:            with this option.
                    172:           n = 0: No proper sound emulation at all. May be incompatible 
                    173:                  (unlikely). This is the default.
                    174:           n = 1: Emulate the sound hardware, but don't output sound. May be
                    175:                  needed for compatibility, but can be much slower
                    176:           n = 2: Emulate the sound hardware and output sound. Recommended.
                    177:           n = 3: Emulate the sound hardware _exactly_. I don't think you'll
                    178:                  hear a difference. SIDmon modules will be emulated 
                    179:                  correctly, but painfully slow with this setting.
                    180:  -b n    : Use n bits for sound output (8 or 16)
                    181:  -R n    : Use n Hz to output sound. Common values are 22050 Hz or 44100 Hz.
                    182:  -B n    : Use a sound buffer of n bytes (use small values on fast machines)
                    183:            Default is 8192.
                    184:           
                    185: Memory options:
                    186:  -s n    : Emulate n*256K slow memory at 0xC00000. Some demos/games need this.
                    187:  -F n    : Emulate n megabytes of fast memory as an expansion board.
                    188:  -c n    : Emulate n*512K chip memory. The default is 2MB chipram. Some very
                    189:            broken programs need "-c 1" to work properly.
                    190:           
                    191: Debugging options:
                    192:  -D      : Don't start the emulator at once, use the built-in debugger.
                    193:  -i      : Print illegal memory accesses
                    194:  -g      : Emulate parts of the OS. This isn't very stable and not
                    195:            recommended.
                    196: 
                    197: Display options:
                    198:  -H mode : Select a color mode to use.
1.1.1.2 ! root      199:  -O specs: Select a display mode, see below how the specs parameter is
        !           200:            interpreted.
1.1       root      201: Color modes: 0 (256 colors, default); 1 (32768 colors); 2 (65536 colors)
                    202:              3 (256 colors, with dithering to improve color quality)
                    203:             4 (16 colors, dithered); 5 (16 million colors)
                    204: 
1.1.1.2 ! root      205: About the "-O" display specs. These consist of the width and height of the
        !           206: mode, plus optional modifiers. One valid option to pass to UAE would be
        !           207: "-O 640:300:" which means use a display 640 pixels wide and 300 pixels high,
        !           208: with no modifiers (nothing after the second ":"). You may specify the
        !           209: following modifiers:
        !           210:  l: Tell UAE to omit drawing every second pixel horizontally (for "lores"
        !           211:     modes). Example: "-O 320:200:l"
        !           212:  x: Tell UAE to try to fit the image horizontally into the displayed
        !           213:     window. For example, if you have a mode that is 640 pixels wide, and the
        !           214:     displayed image is also 640 pixels wide, the picture may still be
        !           215:     partially invisible because it is displayed too wide to the left or to
        !           216:     the right. With the "x" modifier, UAE tries to prevent this.
        !           217:     You can also specify a capital "X", in that case, UAE tries to be
        !           218:     extremely clever when doing this.
        !           219:  y: The same thing in green, for fitting the image vertically into the
        !           220:     window. (Y also exists)
        !           221:  d: Draw every line twice. This allows interlace mode to be emulated nicely,
        !           222:     but of course you also need a display that is twice as high
        !           223:  c: Correct the aspect. This will omit certain lines of the display to make
        !           224:     it fit better into the screen.
        !           225: 
        !           226: Whew. You'll probably have to experiment a little to get a feeling for it.
        !           227: To make things easier, here are mode specs that are equivalent to the old
        !           228: "-d" and "-C" options, which are obsolete now.
        !           229: -d 0: Lores, 320x200, X centered: "-O 320:200:lx"
        !           230: -d 1: Lores, 320x240, X centered: "-O 320:240:lx"
        !           231: -d 2: Lores, 320x400, X centered: "-O 320:400:lx"
        !           232: -d 3: Hires, 640x300, X centered: "-O 640:300:x"
        !           233: -d 4: 800x300, centering not needed: "-O 800:300:"
        !           234: -d 3 -C: "-O 640:600:xd"
        !           235: -d 4 -C: "-O 800:600:d"
        !           236: (This table is accurate for the X11 version of UAE 0.6.6 and below. Other
        !           237: versions, e.g. SVGAlib and DOS behave differently, which was one of the
        !           238: reasons to get rid of the old method of specifying display modes.)
        !           239: 
1.1       root      240: UAE may choose to ignore and/or refuse some combinations of these two
                    241: parameters. Some of these modes may also fail to work on your system.
                    242: 
                    243: You can also put these options into a configuration file in your home
                    244: directory. Simply create ~/.uaerc and put some of these options in it. On
                    245: non-Unix systems, the file is called uae.rc and should be located in the
                    246: current directory.
                    247: 
                    248: 
                    249: Choosing color and screen modes
                    250: ===============================
                    251: 
                    252: As described in the previous paragraph, UAE can run in many different 
                    253: resolutions and color modes. However, few of the color mode options are
                    254: available if you use the X11 version of UAE, since the X server determines
                    255: how many colors are available. If you are running a 256 color X server, you
                    256: can use "-H3" to tell UAE to dither the colors for better results.
                    257: 
                    258: You will have to experiment which mode gives the best results for you at a
                    259: satisfying speed. Note that the dithering process consumes time, so even if
                    260: 256 colors with dithering look better than 256 colors without, remember that
                    261: UAE will be slower in that mode.
                    262: 
                    263: The recommended resolution is 800x600. In the lower resolution modes, some
                    264: overscan pictures the Amiga tries to display may not fit entirely on the
                    265: screen, others may be off-center and some graphical effects may look weird.
                    266: For best results, use 800x600 with at least 32768 colors.
                    267: 
                    268: 
                    269: Harddisk emulation
                    270: ==================
                    271: 
                    272: Using diskfiles is awkward. There are two ways how you can use larger amounts 
                    273: of data with UAE. UAE can emulate more than one harddisk at one time, the
                    274: volumes will be named UAE0:, UAE1:, etc. UAE will boot from UAE0: if no
                    275: diskfile is found for floppy drive 0.
                    276: 
                    277: a) Harddisk files.
                    278: You can create a (unformatted) harddisk file with
                    279: 
                    280:   dd if=/dev/zero of=hardfile bs=512 count=16384
1.1.1.2 ! root      281: 
        !           282: That will create an 8MB file. Other sizes ought to work, too, as long as they
        !           283: are powers of two.
1.1       root      284: 
                    285: The harddisk file is accessed by a resident ROM module that is built into the
                    286: emulator, called "hardfile.device". If it is present, this is always the first
                    287: harddisk device the emulator finds and will be named UAE0:
                    288: 
                    289: If you are using Kickstart 1.3 or earlier, this can't currently be mounted at 
                    290: boot time, and therefore you can't boot from it either. You will have to boot
                    291: either from a floppy disk image or from a filesystem (see below), and mount
                    292: the hardfile.device later. To do this, add the following to "DEVS:mountlist":
                    293: 
                    294: UAE0:     Device = hardfile.device
                    295:           Unit   = 0
                    296:           Flags  = 0
                    297:           Surfaces  = 1
                    298:           BlocksPerTrack = 32
                    299:           Reserved = 1
                    300:           Interleave = 0
                    301:           LowCyl = 0  ;  HighCyl = 511
                    302:           Buffers = 5
                    303:           DosType = 0x444F5300
                    304:           BufMemType = 1
                    305: #
                    306: 
                    307: Then, type "mount UAE0:" (or put that command in your startup-sequence), and
                    308: you should be able to access it. Don't forget to format it with the AmigaDOS
                    309: format command:
                    310: 
                    311:   format drive uae0: name Mister_Willwink
                    312: 
1.1.1.2 ! root      313: The emulated Amiga usually crashes after the format command. I don't know
        !           314: exactly why.
        !           315: 
1.1       root      316: b) Access native filesystems from the emulator.
                    317: 
                    318: This has some major advantages:
                    319:  - It has no problems with Kickstart 1.3
                    320:  - It is more convenient.
                    321:  - It is much faster. In fact, it can be dramatically faster even than a real
                    322:    Amiga when reading directories.
                    323: 
                    324: However, it currently does not work on some ports.
                    325: 
1.1.1.2 ! root      326: If you specify the -M or -m command line arguments, you your native filesystem 
        !           327: from the emulator. If you start UAE with
1.1       root      328: 
                    329:   uae -m sound:/usr/amiga/modules
1.1.1.2 ! root      330: 
1.1       root      331: you can access all the files in /usr/amiga/modules by reading from the
                    332: AmigaDOS volume "SOUND:".
                    333: (DOS users: try "uae -m dh0:C:\" to mount your drive C:\ as DH0:)
                    334: 
                    335: You can mount up to 20 devices by giving this option multiple times.
                    336: 
                    337: 
                    338: Tools / Transferring files
                    339: ==========================
                    340: 
1.1.1.2 ! root      341: As you should know by now, you need to transfer files between your Amiga and
        !           342: the machine you run UAE on. There are several ways how to do this.
        !           343: 
        !           344: - Using a null modem cable, and a terminal package running on each machine,
        !           345:   you can transfer the file(s) via Zmodem upload/download. 68000 equipped
        !           346:   Amigas can normally attain around 3000cps through the null modem cable,
        !           347:   using the standard Commodore serial.device.  However, by using the device
        !           348:   replacement BaudBandit.device, anything up to 5500cps can be attained.
        !           349:   BaudBandit can be obtained from Aminet.  A second alternative is to use
        !           350:   the BASIC program adfi.bas (included with UAE) to transfer a file from the
        !           351:   Amiga to the PC via the null modem cable.
        !           352:   
        !           353: - If you're using CrossDOS on your Amiga, you can compress the disk or
        !           354:   kickstart image using LhA or similar PC compatible archiver and copy it to
        !           355:   a 720KB floppy disk.  You can now take the disk over to the PC, copy the
        !           356:   compressed file to the UAE directory and uncompress it.
        !           357:   If you don't have CrossDOS on the Amiga, there is a similar freeware tool
        !           358:   called Msh, which can be found on Aminet or on Fish disk 382 or 327.
        !           359: 
        !           360: In either case, you ought to read the documentation for the programs that
        !           361: you use for the transfer. These programs can't be explained here.
1.1       root      362: 
1.1.1.2 ! root      363: In the "amiga" subdirectory you'll find two small Amiga programs that will
        !           364: help you to generate the necessary image files. These are called transrom 
1.1       root      365: and transdisk. Copy them to your Amiga and make them executable (by typing
1.1.1.2 ! root      366: "protect transrom rwed" and "protect transdisk rwed" in the Amiga shell
1.1       root      367: window).
                    368: transrom will dump the contents of your Kickstart ROM, and transdisk will 
                    369: dump an image of a floppy in one of the drives. Both programs write to the
1.1.1.2 ! root      370: standard output (read: the screen), so you'll want to redirect that. Do
1.1       root      371: 
                    372:    transrom >ram:kick.rom
                    373:    
                    374: to create a file called "kick.rom" in the RAM disk, and
                    375: 
                    376:    transdisk >ram:df0.adf
                    377:    
                    378: to create a file called "df0.adf" in the RAM disk. These files are pretty
1.1.1.2 ! root      379: big, 262144 or 524288 bytes for the ROM image and 901120 bytes for a disk 
        !           380: image.
1.1       root      381: transdisk understands the following arguments:
                    382: 
                    383:     -d device unit: Use this device instead of DF0:
1.1.1.2 ! root      384:     -s n:           Begin transfer at track n (default: 0)
        !           385:     -e n:           End transfer at track n (default: 79)
        !           386:     -w file:        don't read from the floppy, instead write the contents
        !           387:                     of "file" to the floppy
        !           388:     -h:             Treat the disk as high-density disk. HD images aren't
        !           389:                     supported by UAE yet, though. Note that the resulting
        !           390:                    file will be twice as big.
1.1       root      391: 
                    392: So, to transfer the disk in drive DF1:, you'd give the command:
                    393: 
                    394:   transdisk >ram:df1.adf -d trackdisk 1
                    395: 
                    396: If you don't have much RAM and can't fit all of a disk image in the RAM disk,
                    397: you can split up the transfer into multiple parts with the "-s" and "-e"
                    398: parameters. To transfer the disk in four parts, you'd use the following 
                    399: commands:
                    400:   
                    401:   transdisk >ram:df0_1.adf -s 0 -e 19
                    402:   transdisk >ram:df0_2.adf -s 20 -e 39
                    403:   transdisk >ram:df0_3.adf -s 40 -e 59
                    404:   transdisk >ram:df0_4.adf -s 60 -e 79
                    405: 
                    406: Of course, you should save each of the four files to another place before
                    407: transferring the next one with transdisk to make space in your RAM disk. 
                    408: If you have all the files on your PC, you can do the following under Unix:
                    409:   cat df0_1.adf df0_2.adf df0_3.adf df0_4.adf >df0.adf
                    410: or, under DOS:
1.1.1.2 ! root      411:   COPY /B df0_1.adf+df0_2.adf+df0_3.adf+df0_4.adf df0.adf
1.1       root      412: I've been told there are the following tools for the Mac to join binaries:
                    413: "ChunkJoiner 2.1.2" found under Info-Mac's <disk> directory or 
                    414: "JoinFiles 1.0.1" under Info-Mac's <text>.
                    415: 
                    416: The current transdisk can only read the standard AmigaDOS format. This means
                    417: that most games that rely on some form of copy-protection cannot be
1.1.1.2 ! root      418: transferred (more about disk formats in the file "FAQ")
1.1       root      419: 
1.1.1.2 ! root      420: ****************************************************************************
1.1       root      421: If you transfer commercial software, you must not distribute the resulting
                    422: image files, since that would be a violation of copyright law. The Kickstart
                    423: ROM has to be considered commercial software. You may only use the Kickstart
                    424: from your own Amiga, and you may not distribute Kickstart ROM files.
                    425: Please read the license that came with your software for details.
1.1.1.2 ! root      426: ****************************************************************************
        !           427: 
        !           428: 
        !           429: Retrieving files from a disk image
        !           430: ==================================
1.1       root      431: 
                    432: If you have a disk image file, and you want to retrieve the files from it, you
                    433: can use the "readdisk" tool. It is automatically built by "make". If you have
                    434: a disk image of a disk called "Workbench1.3D" as df0.adf, and you do
                    435:    readdisk df0.adf
                    436: the whole directory structure of the disk image will be stored in a newly
                    437: created subdirectory called "Workbench1.3D". You can optionally give a second
                    438: parameter to specify a directory where to create the output other than the
                    439: current directory.
                    440: readdisk only understands about the OFS right now. FFS disks will cheerfully
                    441: be regarded as being unreadable. Use the unixfs.device from within the
1.1.1.2 ! root      442: emulator if you want to transfer files from FFS disks.
1.1       root      443: 
                    444: 
                    445: The UAE_CONTROL program
                    446: =======================
                    447: 
                    448: In the "amiga" subdirectory, you will find two programs, uae_control and
                    449: uaectrl that provide the same functionality as the X11 GUI. uaectrl is
                    450: shell-based and works with any Kickstart, while uae_control needs the
                    451: gadtools.library and a recent version of reqtools.library, so it only works
                    452: with Kick 2.0 and upwards. Copy these two programs to the directory that you
                    453: use for harddisk emulation. They should be self-explanatory.
                    454: 
                    455: 
                    456: Quick overview of the debugger commands
                    457: =======================================
                    458: 
1.1.1.2 ! root      459: Some (window-system based) ports of UAE have a built-in debugger. You can
        !           460: press ^C at any time to enter this debugger.
1.1       root      461: Each debugger command consists of a single letter and occasionally some
                    462: parameters.
                    463: 
                    464: g:                    Start execution at the current address. 
                    465: c:                    Dump state of the CIA and custom chips.
                    466: r:                    Dump state of the CPU
                    467: m <address> <lines>:  Memory dump starting at <address>
                    468: d <address> <lines>:  Disassembly starting at <address>
                    469: t:                    Step one instruction
                    470: z:                    Step through one instruction - useful for JSR, DBRA etc.
                    471: f <address>:          Step forward until PC == <address>
                    472: q:                    Quit the emulator. You don't want to use this command.
                    473: 
                    474: 
                    475: Sound
                    476: =====
                    477: 
1.1.1.2 ! root      478: If your version of UAE supports sound, you can pass parameters like frequency
        !           479: or number of bits to use on the commandline; if you don't specify any, sane
        !           480: defaults will be used. If graphics output is enabled while sound is output,
        !           481: the emulator will be much too slow on most systems. The sound will not be
        !           482: continuous. Therefore, a hack to turn off screen updates is provided: Press
        !           483: ScrollLock to disable graphics, press it again to enable them.
1.1       root      484: 
                    485: The quality of the emulation depends on the setting of the "-S" commandline
                    486: option. With "-S 3", all of the sound hardware is emulated; and some programs
                    487: (e.g. AIBB) won't run with other settings. "-S 2" should sound just as good as
                    488: "-S 3" and will be much faster for some programs. "-S 1" tries to emulate most
                    489: of the sound hardware, but doesn't actually output sound. "-S 0" completely
                    490: turns off sound.
                    491: 
                    492: 
1.1.1.2 ! root      493: Pointers
        !           494: ========
1.1       root      495: 
1.1.1.2 ! root      496: There are a few sites in the Internet that contain helpful information about
        !           497: UAE.
        !           498: 
        !           499: The new "official" UAE page is located at
        !           500: 
        !           501: http://www.schokola.de/~stepan/uae
        !           502: 
        !           503: thanks to Stefan Reinauer who is now maintaining it.
        !           504: 
        !           505: There, you will find links to other UAE pages. One which is especially useful
        !           506: is the "UAE Discussion Board" set up by Gustavo Goedert, the address is
        !           507: 
        !           508: http://tinos.pucrs.br/~ggoedert/uaeboard.html
1.1       root      509: 
1.1.1.2 ! root      510: Not quite as good as a newsgroup due to braindamaged reader software
        !           511: (Ratscope), but still a blessing.
        !           512: 
        !           513: I post announcements of new versions of UAE to the newsgroup 
        !           514: comp.emulators.misc. From time to time, I also upload new versions to the ftp
        !           515: server sunsite.unc.edu. You will find them either in pub/Linux/Incoming or in
        !           516: pub/Linux/system/Emulators. There are many sunsite mirrors throughout the
        !           517: world, you should be able to find one near you.
1.1       root      518: 
                    519: 
                    520: Thanks & Acknowledgements
                    521: =========================
                    522: 
                    523: Thanks to all who have written me so far with bugreports and success/failure
                    524: reports when trying to run the emulator on various hardware with different
                    525: Kickstart versions. A list of everyone who has contributed to the source code
                    526: can be found in the CREDITS file (this was getting too big to keep it here).
                    527: 
                    528: Special thanks to:
                    529:   - Jay Miner, Dale Luck, R.J. Mical and all the others who built the Amiga.
                    530:   - Felix Bardos, whose HRM I "borrowed".
                    531:   - Hetz Ben Hamo mailed Peter Kittel from Commodore asking for permission to
                    532:     give Kick 1.3 away. Unfortunately, the response was negative :-(
                    533:   - Bruno Coste, Ed Hanway, Alessandro Soldo and Marko Nippula provided 
                    534:     documentation
                    535:   - Fabio Ciucci gets the "Best bug reports" award for his help with the
                    536:     blitter line emulation and other problem areas.
1.1.1.2 ! root      537:   - Michael C. Battilana of Cloanto Software, for being so kind to send me two
        !           538:     CD-ROMs with lots of Amiga software.
1.1       root      539: 
                    540: 
1.1.1.2 ! root      541: Authors/Maintainers
        !           542: ===================
1.1       root      543: 
1.1.1.2 ! root      544: My address is:
1.1       root      545: 
                    546: [email protected]
                    547: 
                    548: or, via snailmail
                    549: 
                    550: Bernd Schmidt
                    551: Schlossweiherstrasse 14
                    552: 52072 Aachen
                    553: Germany
                    554: 
                    555: Email is more likely to be answered, and will definitely be answered much
                    556: faster. Please avoid phonecalls if you can.
1.1.1.2 ! root      557: 
        !           558: The following people have ported UAE to different platforms; you should
        !           559: direct system-specific questions to them:
        !           560: 
        !           561: DOS port:
        !           562:   Gustavo Goedert <[email protected]>
        !           563:   Available: http://tinos.pucrs.br/~ggoedert/dosuae.html
        !           564: 
        !           565: Mac port:
        !           566:   Ernesto Corvi <[email protected]>
        !           567:   Available: info-mac ("every Mac user knows where that is"). A link to the 
        !           568:   archive containing both PPC and 68k binaries is on my Web page. (info-mac
        !           569:   is mirrored by sunsite.informatik.rwth-aachen.de)
        !           570: 
        !           571: BeBox port:
        !           572:   Christian Bauer <[email protected]>
        !           573:   Available: The main UAE web page (use the Unix sources)
        !           574: 
        !           575: NextStep port:
        !           576:   Ian Stephenson <[email protected]>
        !           577:   Available: The main UAE web page (use the Unix sources)
        !           578: 
        !           579: Amiga port:
        !           580:   Originally: Olaf 'Olsen' Barthel <[email protected]>
        !           581:   Currently: Samuel Devulder <[email protected]>
        !           582:   Available: Not quite sure yet. Paul Liss' Web page has binaries.
        !           583: 
        !           584: XFree86/OS2 port:
        !           585:   Krister Bergman <[email protected]>
        !           586:   Available: <http://www.kuai.se/~bellman/html/xfreeapps.html>
        !           587: 
        !           588: Since I generally don't have the possibility to test or improve these ports,
        !           589: it is a good idea to contact their respective authors if you have questions.
        !           590: 
        !           591: 
        !           592: Before you email...
        !           593: ===================
        !           594: 
        !           595: Before you contact me with a problem that you have, make sure you have read
        !           596: _all_ of the above. Please read also the file "FAQ", which contains a lot of
        !           597: helpful informationm, and the README file for your specific system. 
        !           598: 
1.1       root      599: I can't answer _every_ question. If you have trouble understanding this
                    600: README, either because you don't speak English very well or because you have
1.1.1.2 ! root      601: no clue at all about computers, please try to find some friend of yours who 
        !           602: does understand this file and who can translate/explain it for you. I simply
        !           603: can't explain (for example) how to use terminal programs or CrossDOS because
        !           604: I don't use either, and it would be much too time-consuming anyway. This file
        !           605: and the file FAQ contains about every piece of information I can give you. I 
        !           606: try to help people who have questions, but sometimes it takes too much time.
        !           607: 
        !           608: Please don't ask for Kickstart ROM files or other copyrighted software. Don't
        !           609: _send_ me stuff like this either. If you want to send me something else which
        !           610: is big (>= 50K), ask me before or put it somewhere in Webspace.
1.1       root      611: 
                    612: Oh, and another thing: If I promise to do things (like implement new
                    613: features), and forget about them, pester me. That happens occasionally, it's
                    614: a known bug in my brain. I'll have it replaced.

unix.superglobalmegacorp.com

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