summaryrefslogtreecommitdiff
path: root/system/atool/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/atool/README')
-rw-r--r--system/atool/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/system/atool/README b/system/atool/README
new file mode 100644
index 0000000000..183ea20ea1
--- /dev/null
+++ b/system/atool/README
@@ -0,0 +1,21 @@
+atool is a script for managing file archives of various types
+(tar, tar+gzip, zip, etcetera).
+
+The main command is aunpack which extracts files from an archive.
+Did you ever extract files from an archive, not checking whether the
+files were located in a subdirectory or in the top directory of the
+archive, resulting in files scattered all over the place? aunpack
+overcomes this problem by first extracting to a new directory. If
+there was only a single file in the archive, that file is moved to
+the original directory. aunpack also prevents local files from being
+overwritten by mistake.
+
+The other commands provided are apack (to create archives), als (to
+list files in archives), and acat (to extract files to standard out).
+As atool invokes external programs to handle the archives, not all
+commands may be supported for a certain type of archives.
+
+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 is used instead. (atool can be configured not to use file.)