Annotation of uae/docs/README, revision 1.1.1.4

1.1.1.4 ! root        1: This is version 0.7.6 of UAE, the Un*x Amiga Emulator.
1.1       root        2: 
1.1.1.3   root        3: License
                      4: =======
1.1       root        5: 
1.1.1.3   root        6: UAE is available under the terms of the GNU General Public License. See the
                      7: file COPYING that is included in the top level directory of this archive for
                      8: details.
1.1       root        9: 
                     10: 
                     11: Overview
                     12: ========
                     13: 
1.1.1.2   root       14: An emulator is a program which enables you to run software for a machine
                     15: which has non-native hardware and a non-native operating system, on your
                     16: computer.  UAE allows you to run most of the available Amiga software. It is a
                     17: software emulation, meaning that no extra or special hardware is needed to do
                     18: this. The hardware of an Amiga is emulated accurately, so that Amiga software
                     19: is tricked into thinking it is running on the real thing, with your computer's
                     20: display, keyboard, harddisk and mouse taking the parts of their emulated
                     21: counterparts.
1.1       root       22: 
                     23: UAE was developed for Unixoid systems. Meanwhile, it has been ported to the
1.1.1.2   root       24: Mac, DOS, the BeBox, NextStep, the XFree86/OS2 environment and the Amigas (it
                     25: can run itself by now). You should have received several other files along
                     26: with this document with details on how to install and use the version for your
                     27: operating system.
1.1       root       28: 
                     29: This section is just what it says: an overview. Please read _all_ of this
1.1.1.2   root       30: file, especially if you have problems. UAE has many, many features and
                     31: equally many configuration options. If you don't know about them, it's likely
                     32: that UAE doesn't work for you, or doesn't work as good as it could.
                     33: 
                     34: Please read also the file "FAQ" which contains some Frequently Asked
1.1.1.3   root       35: Questions (and even the answers!) You should also look for a document
                     36: describing the specific port of UAE to the operating system you are using,
                     37: for example "BeOS/README" or "DOS/README".
1.1.1.2   root       38: 
                     39: People have complained that the UAE documentation contains only "weird jargon".
                     40: Sorry about this. Despite what MessySoft and Tomato tell you, computer
                     41: programs aren't always easy to use. UAE does require some assistance from you,
                     42: and therefore you should at least understand a bit about computers. After all,
                     43: you are an Amiga fan, so you should know what a Workbench is, don't you think?
1.1       root       44: 
                     45: 
1.1.1.2   root       46: Features
                     47: ========
                     48: 
                     49: This version of UAE emulates:
1.1       root       50: 
1.1.1.2   root       51: - An Amiga 500 Computer, with 68000 or 68020 CPU (68020 includes 68881 FPU)
                     52: - OCS Graphics Chipset, plus big blits from the ECS Chipset
1.1.1.3   root       53: - Up to 2MB Chip RAM and up to 8MB Fast RAM, or 8MB Chip RAM without Fast RAM.
                     54: - Up to 64MB Zorro III Fast RAM, independent of Chip RAM setting.
                     55: - Up to 1MB Slow RAM, for extended compatibility with problem software
                     56: - Up to 8MB of graphics card memory, usable by software that supports
                     57:   Picasso 96 compatible graphics cards.
1.1.1.2   root       58: - 4 x 3.5" floppy disk drives (DF0:, DF1:, DF2: and DF3:)
                     59: - Hard-disk emulation
                     60: - Joystick support (with option of mapping joystick to numeric keypad)
                     61: - Mouse support
                     62: - Ability to run in various screen modes (for better display quality or
                     63:   better speed)
                     64: - Full sound support, consisting of 4 x 8bit channels (mixed into one, so
                     65:   output is mono for now).
1.1.1.3   root       66: - Beta parallel and serial port support
1.1.1.2   root       67: - some other things which don't work well enough to mention them here...
                     68: 
                     69:   
                     70: Requirements (IMPORTANT! READ THIS!)/Limitations
                     71: ================================================
                     72: 
                     73: Not emulated:
1.1.1.3   root       74: - Sprite to playfield collisions (sprite to sprite collisions work)
                     75: - An MMU (part of 68030/040 CPUs except those that Commodore used). This means
1.1.1.2   root       76:   you can't use virtual memory systems or real operating systems like Linux
                     77:   or BSD.
                     78: - The AGA chipset (A4000/A1200). This chipset has enhanced capabilites for
                     79:   up to 256 colors in all resolutions.
                     80: - Serial port emulation exists but doesn't work too well.
                     81: 
                     82: Since the PC floppy controller can't read Amiga disks (yes, that's a fact), 
                     83: floppy access has to be emulated differently: Floppies are emulated by means 
                     84: of disk files that contain a raw image of the floppy disk you want to emulate.
                     85: A disk file is an image of the raw data on an Amiga floppy disk, it contains
                     86: 901120 bytes (880K), which is the standard capacity of an Amiga disk.
                     87: 
                     88: To actually run the program, you'll need to install the ROM image from your
                     89: Amiga. You can't run UAE if you don't have this image. It is not included
                     90: because it is copyrighted software. Don't ask me to send you one. I won't.
                     91: If you don't have an Amiga and still want to use UAE, you'll have to buy an
                     92: Amiga or at least the system software (ROM + Workbench) first.
                     93: The Kickstart image can have a size of either 256K or 512K. It must be named
                     94: "kick.rom" by default.
                     95: 
                     96: Read the section "tools" below for information how to create ROM images and
                     97: disk files.
1.1       root       98: 
                     99: If you don't have a Kickstart file, you may still be able to boot some games
                    100: and demos. The emulator includes some primitive bootstrap code that will try
                    101: to read and execute the bootblock of the diskfile you are using, and if that
                    102: bootblock only uses the one or two Kickstart functions that are supported by 
                    103: the "replacement Kickstart", your program will boot. Don't expect too much, 
                    104: though.
                    105: 
1.1.1.2   root      106: You'll also need some other software to run - why else would you want to
                    107: emulate an Amiga? There are several ways to make the software accessible to
1.1.1.3   root      108: UAE, either with disk image files or with a harddisk emulation. You should
                    109: make an image of your Amiga's Workbench disk and install it as "df0.adf"
                    110: (adf = Amiga Disk File) when you use UAE for the first time. More about how
                    111: to create these files in the chapter "Transferring software"
                    112: 
                    113: To use Picasso96 emulation, you need the Picasso96 libraries, which are also
                    114: not included. They can be obtained (e.g.) from Aminet.
1.1       root      115: 
                    116: 
                    117: Invoking UAE
                    118: ============
                    119: 
1.1.1.2   root      120: First, read the system-specific documents for information how to set up UAE.
                    121: You should have an executable program called "uae". You can simply execute it,
1.1.1.3   root      122: but you can also optionally give it one or more of the following options:
1.1       root      123: 
                    124: General options:
                    125:  -h      : Give help on the options.
1.1.1.2   root      126:  -A n    : Set emulator accuracy to n. The default is n = 2, which means the
                    127:            emulator will try to be as accurate as possible. This no longer
                    128:           does much in this version, and I'll probably remove it.
1.1       root      129:  -f n    : Sets the frame rate to 1/n. Only every nth screen will be drawn.
                    130:  -a      : Add no expansion devices. This will disable fastmem and harddisk
                    131:            emulation, but some extremely badly-written games may need this.
1.1.1.3   root      132:           (Kickstart 1.2 needs it, too)
1.1       root      133:  -l lang : Set the keyboard language. Currently, the following values can be 
                    134:           used for lang: "us" for U.S. keyboard (default), "se" for swedish, 
1.1.1.3   root      135:           "fr" for french, "it" for italian, "es" for spanish, or "de" for
                    136:           german keyboard.
                    137:           This setting only affects the X11 version.
1.1       root      138:  -0 file : Try to use file as diskfile for drive 0 instead of df0.adf.
1.1.1.3   root      139:            The options -1, -2 and -3 also exist for the other drives.
1.1       root      140:  -r file : Use file instead of kick.rom as Kickstart image.
1.1.1.3   root      141:  -J xy   : Specify how to emulate joystick port 0 (x) and 1 (y). Both x and y
                    142:            can be one of the following characters: 0 = joystick 0, 1 =
                    143:            joystick 1, M for mouse, and a, b or c stand for various keyboard
                    144:           replacements (a is the numeric pad with '0' as fire button, b the
                    145:           cursor keys with right control as fire button and c is T/F/H/B with
                    146:           Alt as fire button.
                    147:           The default is "-J M0" (mouse and joystick as usual)
1.1       root      148:  -G      : Disable the user interface (if present).
1.1.1.3   root      149:  -n specs: Set blitter emulation. "specs" is a string of characters. If it
1.1.1.2   root      150:            contains a "3", the blitter will use 32 bit operations where that
                    151:           seems profitable (note that this will cause bus errors on most
                    152:           RISC machines). If you specify "i", all blits will finish 
                    153:           immediately, which can be nice for speed. To enable both options,
                    154:           say "-n 3i"
1.1.1.3   root      155:  -w n    : Set CPU emulation speed to n. The default value is 4; higher values
                    156:            will give the custom chip emulation a higher priority over the CPU,
                    157:           but some programs crash if this is higher than 4. Setting it to 1
                    158:           is a good way to make the emulator run slower on machines which are
                    159:           too fast.
                    160:  -C specs: Controls how the CPU is emulated. The first letter must be '0' for
                    161:            68000 emulation, '1' for 68010, '2' for 68020 or '3' for
                    162:           68020 + 68881. It can be followed by a 'c', which enables a slower
                    163:           but more compatible version of 68000 emulation, or by an 'a', which
                    164:           enables a 24 bit address space for 68020 emulation. Normally you
                    165:           don't want either; use the more compatible emulation if some game or
                    166:           demo does not work. The 24 bit address space option appears to be
                    167:           necessary for some Kickstart ROMs, so try that if things don't work
                    168:           at all.
1.1       root      169: 
1.1.1.3   root      170: Emulating external devices (harddisk, CD-ROM, printer, serial port):
1.1       root      171:  -M VOLUME:path
                    172:  -m VOLUME:path
1.1.1.3   root      173:            Mount the unix file system at "path" as an Amiga filesystem with
1.1       root      174:           volume name "VOLUME:". For example, "-M sound:/usr/amiga/modules"
1.1.1.3   root      175:           If you use -M instead of -m, the volume will be read only. Use this
                    176:           for mounting CD-ROMs. See below.
                    177:  -W secs:heads:nr:file
                    178:            Mount the hardfile "file" as an emulated harddisk, using a geometry
                    179:           of "secs" sectors per track, "heads" surfaces and "nr" reserved
                    180:           blocks. Can be abused to mount floppy images. See below.
1.1       root      181:  -p cmd  : Enable printing. See below.
1.1.1.3   root      182:  -I dev  : Use "dev" as serial device (e.g. /dev/ttyS1 on Linux).
1.1       root      183: 
                    184: Sound options:
1.1.1.3   root      185:  -S specs: If your version of UAE supports sound, this option allows you to
                    186:           tell the emulator how to produce sound. The specs parameter is
                    187:           made up as follows:
                    188:           n:stereo:bits:frequency:minimum buffer size:maximum buffer size
                    189:            You can use one of the following values for "n":
1.1       root      190:           n = 0: No proper sound emulation at all. May be incompatible 
                    191:                  (unlikely). This is the default.
                    192:           n = 1: Emulate the sound hardware, but don't output sound. May be
                    193:                  needed for compatibility, but can be much slower
                    194:           n = 2: Emulate the sound hardware and output sound. Recommended.
                    195:           n = 3: Emulate the sound hardware _exactly_. I don't think you'll
                    196:                  hear a difference. SIDmon modules will be emulated 
                    197:                  correctly, but painfully slow with this setting.
1.1.1.3   root      198:                  Unfortunately, this may also be needed to get some programs
                    199:                  to work (AIBB, for example).
                    200:           Use either 's' or 'm' to set the "stereo" value.
                    201:           For "bits", common values are 8 (low quality) or 16 (high quality).
                    202:           For "frequency", common values are 22050 or 44100. The quality of
                    203:           sound output increases with the frequency.
                    204:           You can specify the minimum and maximum size of the sound buffer.
                    205:           Smaller buffers reduce latency.
                    206:           You don't need to specify all of the options, you can stop after
                    207:           each subpart. Examples: "-S0" (sound off), "-S2:s" (sound on, 
                    208:           stereo), "-S3:m:16:44100" (complete emulation, mono, 16 bits,
                    209:            44100 Hz).
                    210:           Note: high quality sound requires a lot of computing power, so try
                    211:           with different settings if your machine is not fast enough.
                    212: 
1.1       root      213: Memory options:
                    214:  -s n    : Emulate n*256K slow memory at 0xC00000. Some demos/games need this.
                    215:  -F n    : Emulate n megabytes of fast memory as an expansion board.
1.1.1.3   root      216:  -Z n    : Emulate n megabytes of Zorro III fast memory as an expansion board.
1.1       root      217:  -c n    : Emulate n*512K chip memory. The default is 2MB chipram. Some very
1.1.1.3   root      218:            broken programs need "-c 1" to work properly. The largest legal
                    219:           value is "-c 16", which means 8MB chip memory.
                    220:  -4 n    : Usually, UAE uses a 24 bit address space when it emulates a 68000,
                    221:            and a 32 bit address space when it emulates a 68020. If n is 1,
                    222:           this option turns on a 24 bit address space in 68020 emulation. It
                    223:           appears to be necessary for some Kickstart images. Careful: this
                    224:           option has harmful side effects, and should be disabled by default.
                    225: 
                    226: Debugging options (not interesting for most users):
1.1       root      227:  -D      : Don't start the emulator at once, use the built-in debugger.
                    228:  -i      : Print illegal memory accesses
                    229: 
                    230: Display options:
                    231:  -H mode : Select a color mode to use.
1.1.1.2   root      232:  -O specs: Select a display mode, see below how the specs parameter is
                    233:            interpreted.
1.1.1.3   root      234:  -U n    : Emulate a Picasso 96 compatible graphics card with n MB graphics
                    235:            memory.
                    236: 
1.1       root      237: Color modes: 0 (256 colors, default); 1 (32768 colors); 2 (65536 colors)
                    238:              3 (256 colors, with dithering to improve color quality)
                    239:             4 (16 colors, dithered); 5 (16 million colors)
                    240: 
1.1.1.2   root      241: About the "-O" display specs. These consist of the width and height of the
                    242: mode, plus optional modifiers. One valid option to pass to UAE would be
                    243: "-O 640:300:" which means use a display 640 pixels wide and 300 pixels high,
                    244: with no modifiers (nothing after the second ":"). You may specify the
                    245: following modifiers:
                    246:  l: Tell UAE to omit drawing every second pixel horizontally (for "lores"
                    247:     modes). Example: "-O 320:200:l"
                    248:  x: Tell UAE to try to fit the image horizontally into the displayed
                    249:     window. For example, if you have a mode that is 640 pixels wide, and the
                    250:     displayed image is also 640 pixels wide, the picture may still be
                    251:     partially invisible because it is displayed too wide to the left or to
                    252:     the right. With the "x" modifier, UAE tries to prevent this.
                    253:     You can also specify a capital "X", in that case, UAE tries to be
                    254:     extremely clever when doing this.
                    255:  y: The same thing in green, for fitting the image vertically into the
                    256:     window. (Y also exists)
                    257:  d: Draw every line twice. This allows interlace mode to be emulated nicely,
                    258:     but of course you also need a display that is twice as high
                    259:  c: Correct the aspect. This will omit certain lines of the display to make
                    260:     it fit better into the screen.
                    261: 
                    262: Whew. You'll probably have to experiment a little to get a feeling for it.
1.1.1.3   root      263: 
1.1.1.2   root      264: 
1.1       root      265: UAE may choose to ignore and/or refuse some combinations of these two
                    266: parameters. Some of these modes may also fail to work on your system.
                    267: 
                    268: You can also put these options into a configuration file in your home
                    269: directory. Simply create ~/.uaerc and put some of these options in it. On
                    270: non-Unix systems, the file is called uae.rc and should be located in the
                    271: current directory.
                    272: 
                    273: 
                    274: Choosing color and screen modes
                    275: ===============================
                    276: 
                    277: As described in the previous paragraph, UAE can run in many different 
                    278: resolutions and color modes. However, few of the color mode options are
                    279: available if you use the X11 version of UAE, since the X server determines
                    280: how many colors are available. If you are running a 256 color X server, you
                    281: can use "-H3" to tell UAE to dither the colors for better results.
                    282: 
                    283: You will have to experiment which mode gives the best results for you at a
                    284: satisfying speed. Note that the dithering process consumes time, so even if
                    285: 256 colors with dithering look better than 256 colors without, remember that
                    286: UAE will be slower in that mode.
                    287: 
                    288: The recommended resolution is 800x600. In the lower resolution modes, some
                    289: overscan pictures the Amiga tries to display may not fit entirely on the
                    290: screen, others may be off-center and some graphical effects may look weird.
                    291: For best results, use 800x600 with at least 32768 colors.
1.1.1.3   root      292: For speed, use 400x300 lores with 256 colors.
                    293: 
                    294: _Don't_ use 24 bit or 32 bit screen modes, unless you absolutely have to.
                    295: These are way too slow to be usable.
1.1       root      296: 
                    297: 
                    298: Harddisk emulation
                    299: ==================
                    300: 
1.1.1.3   root      301: Since using diskfiles is awkward, it is necessary to emulate harddisks. There
                    302: are two ways how you can use large amounts of data with UAE: harddisk files
                    303: and mounted directories.
                    304: 
                    305: 1. Harddisk files
                    306: 
                    307: Harddisk files are large files that contain the image of an Amiga filesystem.
                    308: They work much the same way as a disk file. You can simply create a large
                    309: empty file and tell UAE to use it as a hardfile, but you will need to format
                    310: it from the emulation before you can actually use it.
1.1       root      311: 
1.1.1.3   root      312: Under Unix, You can create a (unformatted) harddisk file with
1.1       root      313:   dd if=/dev/zero of=hardfile bs=512 count=16384
1.1.1.3   root      314: That will create an 8MB file. Other ports of UAE may come with a utility
                    315: called "makedisk" or other ways to create such a file.
1.1.1.2   root      316: 
1.1.1.3   root      317: To tell the emulator that you want to use a certain file as a hardfile, use
                    318: the "-W" option, for example
                    319:   uae -W 32:1:2:hardfile
                    320: The first three numbers are geometry information which tell the AmigaOS how
                    321: the file is organized. The first number (32) is the number of sectors per
                    322: track, the second number (1) is the number of heads or surfaces, the third
                    323: number (2) is the number of reserved blocks. If you use "normal" sizes
                    324: (powers of two, like 32MB), then you should be OK using the same numbers as
                    325: in the above example. Using different numbers can make sense if you transfer
                    326: the image of a real Amiga harddisk which uses a different geometry. The last
                    327: field of the argument to the "-W" option is the name of the harddisk file.
                    328: 
                    329: If you are using Kickstart 1.3 or earlier, hardfiles can't currently be
                    330: mounted at boot time, and therefore you can't boot from it either. You will
                    331: have to boot either from a floppy disk image or from a filesystem (see below),
                    332: and mount the hardfile.device later. To do this, add the following to
                    333: "DEVS:mountlist":
1.1       root      334: 
1.1.1.3   root      335: UAE0:     Device = uaehf.device
1.1       root      336:           Unit   = 0
                    337:           Flags  = 0
                    338:           Surfaces  = 1
                    339:           BlocksPerTrack = 32
                    340:           Reserved = 1
                    341:           Interleave = 0
                    342:           LowCyl = 0  ;  HighCyl = 511
                    343:           Buffers = 5
                    344:           DosType = 0x444F5300
                    345:           BufMemType = 1
                    346: #
                    347: 
1.1.1.3   root      348: (You may need to adjust the values if you specified a different geometry,
                    349: and/or your hardfile has a different size than 8MB, and/or the hardfile is not
                    350: mounted as UAE0: because you mounted other harddisks before it.)
                    351: 
1.1       root      352: Then, type "mount UAE0:" (or put that command in your startup-sequence), and
                    353: you should be able to access it. Don't forget to format it with the AmigaDOS
                    354: format command:
                    355: 
                    356:   format drive uae0: name Mister_Willwink
                    357: 
1.1.1.3   root      358: b) Accessing native filesystems from the emulator
1.1       root      359: 
                    360: This has some major advantages:
                    361:  - It has no problems with Kickstart 1.3
                    362:  - It is more convenient.
1.1.1.3   root      363:  - It is much faster.
1.1       root      364: 
1.1.1.2   root      365: If you specify the -M or -m command line arguments, you your native filesystem 
                    366: from the emulator. If you start UAE with
1.1       root      367: 
                    368:   uae -m sound:/usr/amiga/modules
1.1.1.2   root      369: 
1.1       root      370: you can access all the files in /usr/amiga/modules by reading from the
                    371: AmigaDOS volume "SOUND:".
                    372: (DOS users: try "uae -m dh0:C:\" to mount your drive C:\ as DH0:)
                    373: 
1.1.1.3   root      374: You can mount up to 20 devices, either hardfiles or filesystems, by giving
                    375: either of these options multiple times. The volumes will be named UAE0:,
                    376: UAE1:, etc. UAE will boot from UAE0: if no diskfile is found for floppy
                    377: drive 0.
                    378: You can also use native filesystems to mount Amiga CD-ROMs, and you can
                    379: abuse the hardfile emulation to mount floppy disks: "uae -W 11:2:2:wb13.adf"
                    380: will mount the diskfile "wb13.adf".
1.1       root      381: 
                    382: 
                    383: Tools / Transferring files
                    384: ==========================
                    385: 
1.1.1.2   root      386: As you should know by now, you need to transfer files between your Amiga and
                    387: the machine you run UAE on. There are several ways how to do this.
                    388: 
                    389: - Using a null modem cable, and a terminal package running on each machine,
                    390:   you can transfer the file(s) via Zmodem upload/download. 68000 equipped
                    391:   Amigas can normally attain around 3000cps through the null modem cable,
                    392:   using the standard Commodore serial.device.  However, by using the device
                    393:   replacement BaudBandit.device, anything up to 5500cps can be attained.
                    394:   BaudBandit can be obtained from Aminet.  A second alternative is to use
                    395:   the BASIC program adfi.bas (included with UAE) to transfer a file from the
                    396:   Amiga to the PC via the null modem cable.
                    397:   
                    398: - If you're using CrossDOS on your Amiga, you can compress the disk or
                    399:   kickstart image using LhA or similar PC compatible archiver and copy it to
                    400:   a 720KB floppy disk.  You can now take the disk over to the PC, copy the
                    401:   compressed file to the UAE directory and uncompress it.
                    402:   If you don't have CrossDOS on the Amiga, there is a similar freeware tool
                    403:   called Msh, which can be found on Aminet or on Fish disk 382 or 327.
                    404: 
                    405: In either case, you ought to read the documentation for the programs that
                    406: you use for the transfer. These programs can't be explained here.
1.1       root      407: 
1.1.1.2   root      408: In the "amiga" subdirectory you'll find two small Amiga programs that will
                    409: help you to generate the necessary image files. These are called transrom 
1.1       root      410: and transdisk. Copy them to your Amiga and make them executable (by typing
1.1.1.2   root      411: "protect transrom rwed" and "protect transdisk rwed" in the Amiga shell
1.1       root      412: window).
                    413: transrom will dump the contents of your Kickstart ROM, and transdisk will 
                    414: dump an image of a floppy in one of the drives. Both programs write to the
1.1.1.2   root      415: standard output (read: the screen), so you'll want to redirect that. Do
1.1       root      416: 
                    417:    transrom >ram:kick.rom
                    418:    
                    419: to create a file called "kick.rom" in the RAM disk, and
                    420: 
                    421:    transdisk >ram:df0.adf
                    422:    
                    423: to create a file called "df0.adf" in the RAM disk. These files are pretty
1.1.1.2   root      424: big, 262144 or 524288 bytes for the ROM image and 901120 bytes for a disk 
                    425: image.
1.1.1.3   root      426: 
                    427: NEVER run either of these programs from the Workbench. Always open a Shell
                    428: or CLI window to do this.
                    429: 
1.1       root      430: transdisk understands the following arguments:
                    431: 
                    432:     -d device unit: Use this device instead of DF0:
1.1.1.2   root      433:     -s n:           Begin transfer at track n (default: 0)
                    434:     -e n:           End transfer at track n (default: 79)
                    435:     -w file:        don't read from the floppy, instead write the contents
                    436:                     of "file" to the floppy
                    437:     -h:             Treat the disk as high-density disk. HD images aren't
                    438:                     supported by UAE yet, though. Note that the resulting
                    439:                    file will be twice as big.
1.1       root      440: 
                    441: So, to transfer the disk in drive DF1:, you'd give the command:
                    442: 
                    443:   transdisk >ram:df1.adf -d trackdisk 1
                    444: 
                    445: If you don't have much RAM and can't fit all of a disk image in the RAM disk,
                    446: you can split up the transfer into multiple parts with the "-s" and "-e"
                    447: parameters. To transfer the disk in four parts, you'd use the following 
                    448: commands:
                    449:   
                    450:   transdisk >ram:df0_1.adf -s 0 -e 19
                    451:   transdisk >ram:df0_2.adf -s 20 -e 39
                    452:   transdisk >ram:df0_3.adf -s 40 -e 59
                    453:   transdisk >ram:df0_4.adf -s 60 -e 79
                    454: 
                    455: Of course, you should save each of the four files to another place before
                    456: transferring the next one with transdisk to make space in your RAM disk. 
                    457: If you have all the files on your PC, you can do the following under Unix:
                    458:   cat df0_1.adf df0_2.adf df0_3.adf df0_4.adf >df0.adf
                    459: or, under DOS:
1.1.1.2   root      460:   COPY /B df0_1.adf+df0_2.adf+df0_3.adf+df0_4.adf df0.adf
1.1       root      461: I've been told there are the following tools for the Mac to join binaries:
                    462: "ChunkJoiner 2.1.2" found under Info-Mac's <disk> directory or 
                    463: "JoinFiles 1.0.1" under Info-Mac's <text>.
                    464: 
                    465: The current transdisk can only read the standard AmigaDOS format. This means
                    466: that most games that rely on some form of copy-protection cannot be
1.1.1.2   root      467: transferred (more about disk formats in the file "FAQ")
1.1       root      468: 
1.1.1.2   root      469: ****************************************************************************
1.1       root      470: If you transfer commercial software, you must not distribute the resulting
                    471: image files, since that would be a violation of copyright law. The Kickstart
                    472: ROM has to be considered commercial software. You may only use the Kickstart
                    473: from your own Amiga, and you may not distribute Kickstart ROM files.
                    474: Please read the license that came with your software for details.
1.1.1.2   root      475: ****************************************************************************
                    476: 
                    477: 
                    478: Retrieving files from a disk image
                    479: ==================================
1.1       root      480: 
                    481: If you have a disk image file, and you want to retrieve the files from it, you
                    482: can use the "readdisk" tool. It is automatically built by "make". If you have
                    483: a disk image of a disk called "Workbench1.3D" as df0.adf, and you do
                    484:    readdisk df0.adf
                    485: the whole directory structure of the disk image will be stored in a newly
                    486: created subdirectory called "Workbench1.3D". You can optionally give a second
                    487: parameter to specify a directory where to create the output other than the
                    488: current directory.
                    489: readdisk only understands about the OFS right now. FFS disks will cheerfully
                    490: be regarded as being unreadable. Use the unixfs.device from within the
1.1.1.2   root      491: emulator if you want to transfer files from FFS disks.
1.1       root      492: 
                    493: 
1.1.1.3   root      494: Picasso 96 graphics card emulation
                    495: ==================================
                    496: 
                    497: To use this feature, you must select 68020 emulation with a 32 bit address
                    498: space. You also need a Kickstart 3.x ROM.
                    499: 
                    500: To specify how much graphic memory you want to emulate, use the "-U" option,
                    501: e.g. "-U 4" for 4 megabytes. Then, you need the Picasso 96 software which
                    502: is not distributed with UAE (There will be a link to the Picasso 96 home page
                    503: on the UAE Web page soon). Version 1.31 or higher is recommended.
                    504: Install the Picasso software, and make sure you enable the "uaegfx" driver.
                    505: After that is complete, reboot, and you should be able to select the new
                    506: modes from the ScreenModes program.
                    507: 
                    508: 
1.1       root      509: The UAE_CONTROL program
                    510: =======================
                    511: 
                    512: In the "amiga" subdirectory, you will find two programs, uae_control and
                    513: uaectrl that provide the same functionality as the X11 GUI. uaectrl is
                    514: shell-based and works with any Kickstart, while uae_control needs the
                    515: gadtools.library and a recent version of reqtools.library, so it only works
                    516: with Kick 2.0 and upwards. Copy these two programs to the directory that you
                    517: use for harddisk emulation. They should be self-explanatory.
                    518: 
                    519: 
                    520: Quick overview of the debugger commands
                    521: =======================================
                    522: 
1.1.1.2   root      523: Some (window-system based) ports of UAE have a built-in debugger. You can
                    524: press ^C at any time to enter this debugger.
1.1       root      525: Each debugger command consists of a single letter and occasionally some
                    526: parameters.
                    527: 
                    528: g:                    Start execution at the current address. 
                    529: c:                    Dump state of the CIA and custom chips.
                    530: r:                    Dump state of the CPU
                    531: m <address> <lines>:  Memory dump starting at <address>
                    532: d <address> <lines>:  Disassembly starting at <address>
                    533: t:                    Step one instruction
                    534: z:                    Step through one instruction - useful for JSR, DBRA etc.
                    535: f <address>:          Step forward until PC == <address>
                    536: q:                    Quit the emulator. You don't want to use this command.
1.1.1.3   root      537: M:                    hunt for sound modules
                    538: S <filename> <address> <len>:
                    539:                       save a sound module
1.1       root      540: 
                    541: 
                    542: Sound
                    543: =====
                    544: 
1.1.1.2   root      545: If your version of UAE supports sound, you can pass parameters like frequency
                    546: or number of bits to use on the commandline; if you don't specify any, sane
                    547: defaults will be used. If graphics output is enabled while sound is output,
                    548: the emulator will be much too slow on most systems. The sound will not be
                    549: continuous. Therefore, a hack to turn off screen updates is provided: Press
                    550: ScrollLock to disable graphics, press it again to enable them.
1.1       root      551: 
                    552: The quality of the emulation depends on the setting of the "-S" commandline
                    553: option. With "-S 3", all of the sound hardware is emulated; and some programs
                    554: (e.g. AIBB) won't run with other settings. "-S 2" should sound just as good as
                    555: "-S 3" and will be much faster for some programs. "-S 1" tries to emulate most
                    556: of the sound hardware, but doesn't actually output sound. "-S 0" completely
                    557: turns off sound.
                    558: 
                    559: 
1.1.1.2   root      560: Pointers
                    561: ========
1.1       root      562: 
1.1.1.2   root      563: There are a few sites in the Internet that contain helpful information about
                    564: UAE.
                    565: 
                    566: The new "official" UAE page is located at
                    567: 
1.1.1.3   root      568: http://www.freiburg.linux.de/~uae
1.1.1.2   root      569: 
                    570: thanks to Stefan Reinauer who is now maintaining it.
                    571: 
                    572: There, you will find links to other UAE pages. One which is especially useful
                    573: is the "UAE Discussion Board" set up by Gustavo Goedert, the address is
                    574: 
1.1.1.3   root      575: http://www.netrunner.com.br/dosuae/uaeboard/index.html
1.1       root      576: 
1.1.1.2   root      577: Not quite as good as a newsgroup due to braindamaged reader software
                    578: (Ratscope), but still a blessing.
                    579: 
1.1.1.3   root      580: There is supposedly a newsgroup named "alt.emulators.amiga", but I don't get
                    581: it here.
                    582: The newsgroup "comp.sys.amiga.emulations" appears to be a proper place to
                    583: discuss Amiga emulation, but, strictly speaking, it is _not_ the right place.
                    584: More appropriate places are "comp.emulators.misc", and, of course, Gustavo's
                    585: discussion board.
                    586: 
                    587: Petter Schau has written another Amiga emulator named "Fellow".  It's mostly
                    588: written in x86 assembly and only runs under DOS.  It's quite compatible and
                    589: generally faster than UAE.  The Fellow homepage is at
                    590: 
                    591: http://www.geocities.com/SiliconValley/Peaks/5244/
1.1       root      592: 
                    593: 
                    594: Thanks & Acknowledgements
                    595: =========================
                    596: 
                    597: Thanks to all who have written me so far with bugreports and success/failure
                    598: reports when trying to run the emulator on various hardware with different
                    599: Kickstart versions. A list of everyone who has contributed to the source code
                    600: can be found in the CREDITS file (this was getting too big to keep it here).
                    601: 
                    602: Special thanks to:
                    603:   - Jay Miner, Dale Luck, R.J. Mical and all the others who built the Amiga.
                    604:   - Felix Bardos, whose HRM I "borrowed".
                    605:   - Hetz Ben Hamo mailed Peter Kittel from Commodore asking for permission to
                    606:     give Kick 1.3 away. Unfortunately, the response was negative :-(
                    607:   - Bruno Coste, Ed Hanway, Alessandro Soldo and Marko Nippula provided 
                    608:     documentation
                    609:   - Fabio Ciucci gets the "Best bug reports" award for his help with the
                    610:     blitter line emulation and other problem areas.
1.1.1.3   root      611:   - Michael C. Battilana and Cloanto Software, for all their support.
                    612:   - Julian Eggebrecht of Factor 5, for providing several F5 games.
1.1       root      613: 
                    614: 
1.1.1.2   root      615: Authors/Maintainers
                    616: ===================
1.1       root      617: 
1.1.1.3   root      618: My address is (please read the section "Before you send email" below):
1.1       root      619: 
                    620: [email protected]
                    621: 
                    622: or, via snailmail
                    623: 
                    624: Bernd Schmidt
                    625: Schlossweiherstrasse 14
                    626: 52072 Aachen
                    627: Germany
                    628: 
                    629: Email is more likely to be answered, and will definitely be answered much
                    630: faster. Please avoid phonecalls if you can.
1.1.1.3   root      631: I won't distribute software, neither PD or commercial. Don't send me floppy
                    632: disks without at least asking first, you will not get them back.
1.1.1.2   root      633: 
                    634: The following people have ported UAE to different platforms; you should
                    635: direct system-specific questions to them:
                    636: 
                    637: DOS port:
1.1.1.3   root      638:   Gustavo Goedert <[email protected]>
                    639:   Available: http://www.netrunner.com.br/dosuae
                    640:   Sourecode: available on the above Web page, most of it included in the
                    641:              main source (with some delay)
1.1.1.2   root      642: 
                    643: Mac port:
1.1.1.3   root      644:   Originally: Ernesto Corvi <[email protected]>
                    645:   Currently: Arnaud Blanchard <[email protected]>
                    646:   Available: http://www.pratique.fr/~jblancha/
                    647:   Sourcecode: extra package available. Bits and pieces in the main source,
                    648:               but nothing you could get to compile.
1.1.1.2   root      649: 
                    650: BeBox port:
                    651:   Christian Bauer <[email protected]>
                    652:   Available: The main UAE web page (use the Unix sources)
1.1.1.3   root      653:   Sourcecode: Included in the main source. Should compile OK.
                    654:   Notes: Christian says he doesn't have much time to spend on UAE, so if
                    655:          anyone is willing to help maintain this port, please speak up.
1.1.1.2   root      656: 
                    657: NextStep port:
                    658:   Ian Stephenson <[email protected]>
                    659:   Available: The main UAE web page (use the Unix sources)
1.1.1.3   root      660:   Sourcecode: Included in the main source. Should compile OK.
                    661:   Notes: Ian says he doesn't have much time to spend on UAE, so if
                    662:          anyone is willing to help maintain this port, please speak up.
1.1.1.2   root      663: 
                    664: Amiga port:
                    665:   Originally: Olaf 'Olsen' Barthel <[email protected]>
                    666:   Currently: Samuel Devulder <[email protected]>
                    667:   Available: Not quite sure yet. Paul Liss' Web page has binaries.
1.1.1.3   root      668:   Sourcecode: Included in the main source. Should compile OK.
1.1.1.2   root      669: 
1.1.1.3   root      670: pOS port:
                    671:   Samuel Devulder <[email protected]>
                    672:   Available: Not quite sure yet.
                    673:   Sourcecode: Included in the main source. Should compile OK.
                    674:   
1.1.1.2   root      675: XFree86/OS2 port:
                    676:   Krister Bergman <[email protected]>
1.1.1.3   root      677:   Available: http://www.kuai.se/~bellman/html/xfreeapps.html
                    678:   Sourcecode: nothing special, apparently the Unix stuff compiles cleanly (?)
1.1.1.2   root      679: 
1.1.1.3   root      680: Win32 port:
                    681:   Mathias Ortmann <[email protected]>
                    682:   Brian King <[email protected]>
                    683:   Available: http://www.informatik.tu-muenchen.de/~ortmann
                    684:              http://www.codepoet.com/uae
                    685:   Sourcecode: we're working on it
                    686: 
                    687: Acorn RISC PC port:
                    688:   Peter Teichmann <[email protected]>
                    689:   Available: http://www.wh1.tu-dresden.de/~sol/acorn.shtml
                    690:              http://www.wh1.tu-dresden.de/~sol/acorne.shtml
                    691:   Sourcecode: Some of it is included in the main source, but since Acorn's OS
                    692:               apparently doesn't have decent file handling, you can't even
                    693:              use the same source layout. Also needs lots of additional files.
                    694:              
1.1.1.2   root      695: Since I generally don't have the possibility to test or improve these ports,
                    696: it is a good idea to contact their respective authors if you have questions.
                    697: 
                    698: 
1.1.1.3   root      699: Before you send email...
                    700: ========================
1.1.1.2   root      701: 
                    702: Before you contact me with a problem that you have, make sure you have read
                    703: _all_ of the above. Please read also the file "FAQ", which contains a lot of
1.1.1.3   root      704: helpful information, and the README file for your specific system. 
1.1.1.2   root      705: 
1.1       root      706: I can't answer _every_ question. If you have trouble understanding this
                    707: README, either because you don't speak English very well or because you have
1.1.1.2   root      708: no clue at all about computers, please try to find some friend of yours who 
                    709: does understand this file and who can translate/explain it for you. I simply
                    710: can't explain (for example) how to use terminal programs or CrossDOS because
                    711: I don't use either, and it would be much too time-consuming anyway. This file
                    712: and the file FAQ contains about every piece of information I can give you. I 
                    713: try to help people who have questions, but sometimes it takes too much time.
                    714: 
                    715: Please don't ask for Kickstart ROM files or other copyrighted software. Don't
                    716: _send_ me stuff like this either. If you want to send me something else which
                    717: is big (>= 50K), ask me before or put it somewhere in Webspace.
1.1.1.3   root      718: If I get 3MB of screen shots or a core dump ("it doesn't work, it generates
                    719: this file"), I'm very likely to get extremely angry, I might complain to your
                    720: sysadmin, and you might lose your account. Think twice.
                    721: 
                    722: I'm also going to be extremely annoyed if you send email in HTML format.
                    723: Fight this disease!
1.1       root      724: 
                    725: Oh, and another thing: If I promise to do things (like implement new
                    726: features), and forget about them, pester me. That happens occasionally, it's
                    727: 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.