atool - Overview
================

atool is a script for managing file archives of various types (tar,
tar+gzip, zip etc). The main command is probably aunpack,
extracting files from an archive. It overcomes the dreaded "multiple
files in archive root" problem by first extracting to a unique
subdirectory, and then moving back the files if possible. aunpack
also prevents local files from being overwritten by mistake.

Other commands provided are apack (create archives), als
(list files in archives), and acat (extract files to standard
out).

atool identifies archives by their file extension. Sometimes this
is not possible, for instance rar archives usually have varying
numeric file extensions. In those cases when atool can't identify
the format, file(1) is used instead. (atool can also be configured
not to use file.)

atool is written in Perl by Oskar Liljeblad (oskar@osk.mine.nu),
and is free software (GNU General Public License).

License
=======

atool is copyright (C) 2001-2003  Oskar Liljeblad

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

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 the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

Requirements
============

The following programs are required for proper operation of atool:

* Perl 5.004 or later
  The modules File::Spec, File::Basename, Getopt::Long and POSIX must be
  available.

The following programs are optional:

* file
  A program to determine file types, found in most unices.
  This is necessary unless you choose to disable the use_file option.
  Debian: file

* tar
  Required if you want to use atool with tar archives.
  Note: See the Installation section below if you don't
  use GNU tar 1.13.18 or later.
  Debian: tar

* gzip (GNU zip)
  Required if you want to use atool with gzip compressed archives.
  Debian: gzip

* bzip
  Required if you want to use atool with bzip compressed archives.
  Debian: bzip

* bzip2
  Required if you want to use atool with bzip2 compressed archives.
  Debian: bzip2

* lzop
  Required if you want to use atool with lzop compressed archives.
  Debian: lzop

* Info-ZIP Zip and Unzip
  Required if you want to use atool with zip archives.
  (zip/unzip from other vendors might work as well.)
  This program can be downloaded from
  http://www.info-zip.org/pub/infozip/Zip.html.
  Debian: zip, unzip

* Eugene Roshal's RAR and UnRAR
  Required if you want to use atool with rar archives.
  This program can be downloaded from http://www.rarsoft.com/.
  Debian: rar, unrar

* LHa for UNIX
  Required if you want to use atool with lha, lharc and similar
  archives. This program can be downloaded from
  http://shibuya.cool.ne.jp/lha/ or
  http://www2m.biglobe.ne.jp/~dolphin/lha/lha.htm.
  Debian: lha

* UnAce for Linux
  Required if you want to use atool with ace archives.
  This program can be downloaded from http://www.winace.com or
  http://www.winace.com/cgi-bin/getfile.exe?program=LinUnAce&width=628.
  Debian: unace

* ARJ and UNARJ for Linux
  Required if you want to use atool with arj archives.
  The unarj program can be downloaded from ftp://ftp.std.com/pub/arj/,
  ftp://sunsite.unc.edu/pub/Linux/utils/compress/unarj241a.tar.gz.
  The arj program can be downloaded from
  http://unc.dl.sourceforge.net/sourceforge/arj/.
  Debian: arj, unarj

* Red Hat Package Manager
  Required if you want to use atool with rpm archives.
  This program can be downloaded from http://www.rpm.org/.
  Debian: rpm

* cpio (GNU cpio)
  Required if you want to use atool with cpio archives.
  This program can be downloaded from http://www.gnu.org/software/cpio/.
  Debian: cpio

* arc
  Required if you want to use atool with ARC archives
  (all commands supported).
  This program can be downloaded from
  http://sources.isc.org/archiver/arc-5.21.txt.
  Debian: arc

* nomarch
  Required if you want to use atool with ARC archives
  (extract and list commands supported).
  This program can be downloaded from
  http://rus.members.beeb.net/nomarch.html.
  Debian: nomarch

Building
========

To build all files simply run

  ./configure

The configure script accepts quite a few options, use the following
command to review them:

  ./configure --help

Installation
============

Installing atool is a matter of copying the atool file to some
appropriate binary directory, usually /usr/local/bin.
After that, symbolic links for apack, aunpack, als and acat
are created to atool in the same directory.

All this can be done automaticly by running `make install'.

If your Perl binary resides in a different place than /usr/bin/perl,
you need to edit the atool script and update the first line with the
corrent path.

There are some configuration variables in the top of the atool Perl
script that you might want to change, depending on the available
software. It is also possible to create a system wide configuration
file overriding these default values (see below).

Usage and Configuration
=======================

A list of options that atool accepts can be displayed by
running atool with the --help option:

  $ atool --help

Please see the manual page for atool for full usage and
configuration information. This document can usually be
viewed this way:

  $ man ./atool.1

or

  $ man -l atool.1

Supported formats
=================

Please see the supplied manual page, as described above.

Homepage
========

The latest version of atool can be downloaded from

  http://www.student.lu.se/~nbi98oli/

Feedback
========

The author of atool and this document, Oskar Liljeblad,
can be reached via email address

  oskar@osk.mine.nu
  
Please send bug reports, suggestions, ideas or comments
in general to me - I would like to hear from you if you
like (or don't like) atool. :)

Known bugs
==========

Please see the KNOWN BUGS section of the atool.1 manual page.

Possible things to do
=====================

Please see the TODO document.

-
