README

   1 atool - Introduction
   2 ====================
   3
   4 atool is a script for managing file archives of various types (tar,
   5 tar+gzip, zip etc).
   6
   7 The main command is aunpack which extracts files from an archive. Did you
   8 ever extract files from an archive, not checking whether the files were
   9 located in a subdirectory or in the top directory of the archive, resulting
  10 in files scattered all over the place? aunpack overcomes this problem by
  11 first extracting to a new directory. If there was only a single file in the
  12 archive, that file is moved to the original directory. aunpack also
  13 prevents local files from being overwritten by mistake.
  14
  15 The other commands provided are apack (to create archives), als (to list
  16 files in archives), and acat (to extract files to standard out). As atool
  17 invokes external programs to handle the archives, not all commands may be
  18 supported for a certain type of archives.
  19
  20 atool identifies archives by their file extension. Sometimes this is not
  21 possible - for instance rar archives usually have varying numeric file
  22 extensions. In those cases when atool can't identify the format, file is
  23 used instead. (atool can be configured not to use file.)
  24
  25 atool is written in Perl by Oskar Liljeblad and is free software (GNU
  26 General Public License).
  27
  28 Copyright and License
  29 =====================
  30
  31 atool is Copyright (C) 2001, 2002, 2003, 2004, 2005 Oskar Liljeblad
  32
  33 This program is free software; you can redistribute it and/or modify it
  34 under the terms of the GNU General Public License as published by the Free
  35 Software Foundation; either version 2 of the License, or (at your option)
  36 any later version.
  37
  38 This program is distributed in the hope that it will be useful, but WITHOUT
  39 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  40 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  41 more details.
  42
  43 You should have received a copy of the GNU General Public License along
  44 with this program; if not, write to the Free Software Foundation, Inc., 51
  45 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  46
  47 The source code of this project may contain files from other projects, and
  48 files generated by other projects, including:
  49
  50  * GNU Autoconf (http://www.gnu.org/software/autoconf/)
  51
  52 Such files are licensed under the terms of the GNU General Public License
  53 or a license compatible with the GNU GPL (as listed on
  54 http://www.gnu.org/licenses/license-list.html). See each file for copyright
  55 details.
  56
  57 Requirements
  58 ============
  59
  60 The following programs are required to run atool:
  61
  62  * Perl 5.004 or later
  63
  64    atool is written in Perl. The modules File::Spec, File::Basename,
  65    Getopt::Long and POSIX must be available (they probably are by default).
  66
  67    site: http://www.perl.org/
  68
  69    package: perl
  70
  71 The following programs are optional for running atool:
  72
  73  * file
  74
  75    file is used to determine file types, and is found in most unices by
  76    default. This program is necessary unless you choose to disable the
  77    use_file option.
  78
  79    site: ftp://ftp.astron.com/pub/file/
  80
  81    package: file
  82
  83  * tar (GNU tar)
  84
  85    tar is required if you want to use atool with tar archives.
  86    Implementations other than GNU's will work with atool as well, but see
  87    the Installation section below if you don't use GNU tar 1.13.18 or
  88    later.
  89
  90    site: http://www.gnu.org/software/tar/tar.html
  91
  92    package: tar
  93
  94  * gzip (GNU zip)
  95
  96    gzip is required if you want to use atool with gzip compressed archives.
  97
  98    site: http://www.gzip.org/
  99
 100    package: gzip
 101
 102  * bzip
 103
 104    bzip is required if you want to use atool with bzip compressed archives.
 105    Note that bzip is obsoleted by bzip2.
 106
 107  * bzip2
 108
 109    bzip2 is required if you want to use atool with bzip2 compressed
 110    archives.
 111
 112    site: http://www.bzip.org/
 113
 114    package: bzip2
 115
 116  * lzop
 117
 118    lzop is required if you want to use atool with lzop compressed archives.
 119
 120    site: http://www.lzop.org/
 121
 122    package: lzop
 123
 124  * zip/unzip (Info-ZIP Zip/Unzip)
 125
 126    Zip is required if you want to use atool with zip archives.
 127    Implementations other than Info-ZIP's might work with atool as well.
 128
 129    site: http://www.info-zip.org
 130
 131    packages:zip, <c unzip
 132
 133  * rar (Eugene Roshal's RAR and UnRAR)
 134
 135    RAR is required if you want to use atool with rar archives.
 136    Implementations other than Eugene Roshal's might work with atool as
 137    well.
 138
 139    site: http://www.rarsoft.com/
 140
 141    package: rar, unrar
 142
 143  * lha (LHa for UNIX)
 144
 145    LHa is required if you want to use atool with lha, lharc and similar
 146    archives.
 147
 148    site: http://www.infor.kanazawa-it.ac.jp/~ishii/lhaunix/
 149
 150    package: lha
 151
 152  * unace (UnAce for Linux)
 153
 154    UnAce is required if you want to use atool with ace archives.
 155
 156    site: http://www.winace.com
 157
 158    package: unace
 159
 160  * arj
 161
 162    Arj is required if you want to use atool with arj archives.
 163
 164    site: http://arj.sourceforge.net
 165
 166    package: arj
 167
 168  * Red Hat Package Manager
 169
 170    The Red Hat Package Manager is required if you want to use atool with
 171    rpm archives.
 172
 173    site: http://www.rpm.org/
 174
 175    package: rpm
 176
 177  * cpio (GNU cpio)
 178
 179    cpio is required if you want to use atool with cpio archives. Other
 180    implmentations than GNU's might work as well.
 181
 182    site: http://www.gnu.org/software/cpio/
 183
 184    package: cpio
 185
 186  * arc
 187
 188    arc is required if you want to use atool with ARC archives (all commands
 189    supported).
 190
 191    site: http://sources.isc.org/archiver/arc-5.21.txt
 192
 193    package: arc
 194
 195  * nomarch
 196
 197    nomarch is required if you want to use atool to list and extract files
 198    from ARC archives.
 199
 200    site: http://rus.members.beeb.net/nomarch.html
 201
 202    package: nomarch
 203
 204  * p7zip
 205
 206    p7zip is required if you want to use atool with 7z archives.
 207
 208    site: http://p7zip.sourceforge.net/
 209
 210    package: p7zip
 211
 212  * unalz
 213
 214    unalz is required if you want to use atool with alzip archives.
 215
 216    site: http://www.kipple.pe.kr/win/unalz/
 217
 218    package: unalz
 219
 220 Building
 221 ========
 222
 223 To build all files, simply run
 224
 225    ./configure
 226
 227 The configure script accepts a few options - use the following command to
 228 show them:
 229
 230    ./configure --help
 231
 232 Installation
 233 ============
 234
 235 Installing atool is a matter of copying the atool file to some appropriate
 236 directory for executable files, usually /usr/local/bin. After that,
 237 symbolic links for apack, aunpack, als and acat to atool should be created
 238 in the same directory.
 239
 240 All this can be done automaticly by running
 241
 242    make install
 243
 244 It is possible to create a system wide configuration file overriding
 245 default values found in the top of the atool script (see below).
 246
 247 Usage and Configuration
 248 =======================
 249
 250 A list of options that atool accepts can be displayed by running atool with
 251 the --help option:
 252
 253    atool --help
 254
 255 Please see the manual page for atool for full use and configuration
 256 information. This document can usually be viewed this way:
 257
 258    man ./atool.1
 259
 260 Supported formats
 261 =================
 262
 263 Please see the supplied manual page, as described above.
 264
 265 Homepage
 266 ========
 267
 268 Web site and file area for atool is hosted on Savannah:
 269
 270    http://www.nongnu.org/atool/
 271
 272 The latest version of atool should always be available on this site.
 273
 274 Feedback
 275 ========
 276
 277 The author of atool and this document, Oskar Liljeblad, can be reached by
 278 e-mail:
 279
 280    oskar@osk.mine.nu (mailto:oskar@osk.mine.nu)
 281
 282 Please send bug reports, suggestions, ideas or comments in general to me -
 283 I would like to hear from you if you like (or don't like) atool.
 284
 285 Known bugs and missing features
 286 ===============================
 287
 288 Please see the KNOWN BUGS section of the atool.1 manual page.
 289
 290 Things to do
 291 ============
 292
 293 Please see the TODO document.
 294
 295 -