Read Me

Apple II ProDOS Filesystem for Linux
Copyright (c) 2001 Matt Jensen (mjensen@obvion.com)
-------------------------------------------------------------------------------

[this file is a work in progress]

CONTENTS
1.  Introduction
2.  Licensing
3.  Installing
4.  Mounting
5.  Contacts

-------------------------------------------------------------------------------
1.  Introduction

This driver allows the Linux kernel to access files on Apple II ProDOS (and
Apple /// SOS) volumes.  It supports any block device that is supported by the
kernel, including hard disks, Zip disks, and CD-ROMs.

At the time of this writing, the driver is considered experimental and does not
support writing to ProDOS volumes.

-------------------------------------------------------------------------------
2.  Licensing

The driver is distributed under the terms of the GNU General Public License,
version 2.  A copy of the license (COPYING) is included in the distribution.

-------------------------------------------------------------------------------
3.  Installing

Before the driver can be installed, it must be compiled.  Compiling should be
a very simple process: simply 'cd' to the source directory and type 'make' at
the shell prompt.

The driver will be compiled into a file named 'prodos.o'.  Link that file into
the running kernel by typing 'insmod prodos.o' at the shell prompt.

-------------------------------------------------------------------------------
4.  Mounting

Once the driver has been compiled and linked into the kernel, mounting a ProDOS
volume is similar to mounting any other type of filesystem.  Simply use
'prodos' as the filesystem type passed to 'mount'.

The following options are available when mounting a ProDOS volume.  For more
information on mounting and mount options, type 'man mount' at the shell
prompt.  Pay special attention to the '-o' switch for passing options.

verbose
	Causes extra debugging messages to be printed to the console.

crconv
	Turns on CR<->LF conversions for plain text files.

case=asis|lower
	Sets filename character case handling. "asis" causes filenames to be
	displayed in the case in which they appear on disk.  "lower" forces
	filenames to be displayed in all lowercase.
	Default: asis

forks=hide|show
	Sets visibility of individual fork "files." "hide" causes only a single
	merged file to appear in directory listings. "show" causes two
	additional files to appear for each extended file: <filename>_d and
	<filename>_r which provide access to each fork independently.  The fork
	files are available even when the value is "hide"--they simply aren't
	shown in directory listings.
	Default: hide

partition=?
part=?
	Specifies the partition to mount for media that has been partitioned
	via the Apple partitioning scheme. "?" can be either the partition's
	name, or its zero-based index into the partition table.

-------------------------------------------------------------------------------
5.  Contacts

I can be contacted via e-mail at mjensen@obvion.com.