view release on metacpan or  search on metacpan

lib/AppleII/LibA2.pm  view on Meta::CPAN

#---------------------------------------------------------------------
package AppleII::LibA2;
#
# Copyright 2015 Christopher J. Madsen
#
# Author: Christopher J. Madsen <perl@cjmweb.net>
# Created: 11 Jul 2015
#
# This program is free software; you can redistribute it and/or modify
# it under the same terms as Perl itself.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either the
# GNU General Public License or the Artistic License for more details.
#
# ABSTRACT: Apple II emulator & file utilities
#---------------------------------------------------------------------

our $VERSION = '0.201';
# This file is part of AppleII-LibA2 0.201 (September 12, 2015)

use 5.006;
use strict;
use warnings;

1;

__END__

=head1 NAME

AppleII::LibA2 - Apple II emulator & file utilities

=head1 VERSION

This document describes version 0.201 of
AppleII::LibA2, released September 12, 2015
as part of AppleII-LibA2 version 0.201.

=head1 DESCRIPTION

AppleII-LibA2 (formerly called LibA2, and still called that
informally) is a collection of both end-user utilities and library
modules for accessing files on Apple II ProDOS disk images for use
with most Apple II emulators.

This is a BETA release of LibA2.  There's some documentation, but it's
not complete.  If you want to see the rest of the documentation, then
send email!  Otherwise, I'll probably never get around to writing it.
Until then, use the source, Luke!  There are still probably some bugs,
and the interfaces might still change.  Use at your own risk.  Keep a
recent backup handy.  Wait sixty minutes before swimming.

All this having been said, I'm not aware of any serious bugs in LibA2
(besides the ones listed in the BUGS section below).  Good luck!
I would very much like to hear from everyone who tries LibA2.  The
more comments I get, the more likely I am to do more work on it.
Please send comments and questions to me.  Bug reports and patches
should go to the CPAN RT for LibA2: F<bug-AppleII-LibA2 AT rt.cpan.org>, or
through the web interface:

L<http://rt.cpan.org/Public/Bug/Report.html?Queue=AppleII-LibA2>

You'll find my email address at the end of this file.

=head2 Command-Line Utilities

The included utilities are:

=over 4

=item C<prodos>

L<prodos> is the main end-user utility.  It provides a
Unix-style shell for accessing ProDOS volumes.  This allows
you to list the contents of disk images, create
subdirectories, and copy files to & from disk images.  If you
have installed the Term::ReadKey and Term::ReadLine modules,
the shell will have better editing, command & filename
completion, and a command history.

The parameters for C<prodos> are:

  prodos IMAGE_FILE

=item C<pro_fmt>

L<pro_fmt> creates blank ProDOS disk images.  The images are
NOT bootable, because they lack the necessary code in the boot
blocks.  You can copy blocks from a bootable disk image to
fix this.  The parameters for C<pro_fmt> are:

  pro_fmt [options] IMAGE_FILE

=item C<pro_opt>

L<pro_opt> removes unused space from ProDOS disk images.  This
is most useful for reducing the size of hard disk images.  It
doesn't use any form of compression; it simply moves
everything to the beginning of the disk, squashing out empty
space caused by deleting files.  Be careful with this, as it's
likely to have some bugs left.  The parameters for C<pro_opt> are:

  pro_opt SOURCE_IMAGE_FILE  DESTINATION_IMAGE_FILE

=item C<awp2txt>

L<awp2txt> converts AppleWorks word processor files into text
files.  This is a bit out of place in LibA2, because it has
nothing to do with disk images, but I included it because
users of LibA2 may find it useful.  The parameters for C<awp2txt> are: