APPLE2IX(6)

NAME
apple2ix - Apple //e emulator

SYNOPSIS
apple2ix

DESCRIPTION
apple2ix emulates a 128k Apple //e computer. To use the emulator effectively you need to acquire the original //e ROM file which is not distributed due to copyright reasons. The emulator reads standard 143360-byte and 232960-byte disk image files with .dsk , .do , and .nib suffixes.

There are only a few command line options:

--help
    Display a quick help

--version
    Display version of emulator

--noshm
    Run emulator with no shared memory (for remote X11 desktops)

THE .apple2 FILE
The emulator reads user preferences from a .apple2 file located in your home directory. This file is auto-magically created for you. .apple2 You can edit the settings using your favorite editor, but most of the settings can be adjusted from the emulator itself (see menus section below).

speed
    Multiple of the Apple //e CPU speed. 1.0 attempts to match the speed of the //e. 2.0 is twice as fast. 0.5 is half.

altspeed
    Alternate speed setting. F9 key in emulator will toggle between this and the regular configured speed. This is useful to slow or speed up emulation as needed.

disk path
    Toplevel path of disk images directory. Personally I like /path/to/your/home/directory/.apple2ix/disks

color
    Color modes. One of Black/white, color, interpolated.

video
    The size of the emulation 1X, 2X

volume
    Speaker Volume setting 0-10

joystick
    Off, joy keypad, or pc joystick

pc joystick parms
    PC Joystick calibration parameters. This is best adjusted from the calibration routine from within the emulator. Press F10 to bring up the settings menu and select Calibrate Joystick. If the emulator complains that it cannot open the joystick device, make sure your joystick or gamepad is connected to the PC and make sure the Linux joystick module is loaded.

keypad joystick parms
    Keypad/arrow-keys joystick parameters. Change this through the calibration routine from the F10 settings menu.

system path
    The directory holding the rom files. The emulator won't run if this is not set properly. You can only change this by editing the .apple2 file.

A sample .apple2 file:
        speed = 1.00
        altspeed = 4.00
        disk path = /usr/local/games/apple2/disks
        color = interpolated
        video = 1X
        volume = 8
        joystick = joy keypad
        system path = /usr/local/games/apple2/rom
        pc joystick parms = 128 128 255 1 255 1
        keypad joystick parms = 8 1

ROM FILES
The emulator requires several ROM files to run.

slot6.rom
    You need this file for basic disk drive emulation. It is 256 byte memory dump of the consecutive addresses from C600 to C6FF. This file is not distributed again due to copyright issues. This file may also be named controller.rom, but is referenced internally as slot6.rom.

apple_IIe.rom
    It is the 32K ROM of your 128k Apple //e, a dump of main memory (bank 0) addresses C000-FFFF concatenated with auxiliary memory (bank 1) addresses C000-FFFF. Because the apple_IIe.rom contains the C600 slot, you can construct the slot6.rom file from this one. The apple_IIe.rom file may also be named apple2e.rom but is referenced internally as apple_IIe.rom.

DISK IMAGES
The emulator reads standard DOS3.3-order 143360 byte '.dsk' images (sometimes with a '.do' extension and raw-nibble 232960 byte '.nib' images. The emulator will also attempt to read and write to compressed disk images with an additional .gz extension.

The images are raw binary dumps, containing the tracks from 0 to 34 from the original 5.25 disk. For the standard 143360 byte '.dsk' format each track is partitioned into sectors of 256 bytes, numbered from 0 to 15.

The raw nibblized 232960-byte images are usually made of programs that have non-standard formatting as a means of copy protection. The nibblized format attempts to preserve the non-standard format, and so defeats the copy protection without "cracking" the program.

To transfer Apple ][ diskettes into one of these formats requires that you own an original Apple ][. Since the drives provided by the IBM PC's are not compatible with the original Apple ][ drives there are no conversion programs directly available. If you have used other Apple ][ emulators it is most likely that the files will work with this emulator too. For more information on Apple ][ disk formats and such, see Beneath Apple DOS by Don Worth and Pieter Lechner, published long ago by Quality Software.

EMULATOR KEYS/MENUS

F1  Interface to switch disk in Drive A, Slot 6. Arrow keys navigate the selection. If the disk highlighted is already in the drive, it will have a <rw1> or <r1> tag after the name indicating read/write or read-only access. Select this disk to eject it. To select a disk, you can press 'w' or RETURN to insert it into the drive. Pressing 'w' will attempt to open the disk as read/write (if you have permission to do so). Pressing RETURN defaults to opening the disk read-only. Press ESC to accept current settings and exit the menu.

F2  Interface to switch disk in Drive B, Slot 6. Same controls as for F1.

Pause/Break key
    Pause the emulation. Hit a key to resume emulation.

F5  Display the Apple //e keyboard layout.

F7  Enter the Debugger console (if this support was compiled into the program). See the file README.debugger that came with the emulator for more information.

F8  The boot/welcome screen! Just in case you need to get back here =)

F9  Toggles between the speed and altspeed settings. This is useful to 'fastboot' programs, or possibly to slow them down, and then slip back to normal Apple //e speed.

F10 General parameter settings menu, including the all-important QUIT option. You can edit most of the parameters in your .apple2 file from this menu. Adjusting a parameter will auto-magically save it to your .apple preferences file. You can also select to calibrate/tune the PC Joystick or keypad joystick here.

Special Keys
    The key combination Ctrl-End will trigger an Apple //e reset. Ctrl-AltLeft-End operates just like a Ctrl-OpenApple-Reset and reboots the Apple //e. AltLeft and AltRight keys correspond to the OpenApple and ClosedApple keys (joystick buttons 0 & 1). NOTE: In //e mode try Ctrl-AltRight-End to trigger a system self-test. The numeric keypad and general arrow keys are also used for emulated joystick movement.

BUGS AND STUFF
See the PROBLEMS file that came with the code.

MORE INFO
More information is available in the online newsgroups comp.emulators.apple2, and comp.sys.apple2.

See also:

Apple //e Technical Reference Manual

Beneath Apple DOS

Beneath Apple ProDOS

AUTHORS
See the AUTHORS file that was packaged with this software.