atool-0.39.0.tar.gz
[atool.git] / atool.1.in
blob11af5334d4181360cf3ecb7e86f2f20be6640a2c
1 .\"                                      -*- nroff -*-
2 .\" atool.1 - Manual page for atool.
3 .\"
4 .\" Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008,
5 .\" 2009, 2011 Oskar Liljeblad
6 .\"
7 .\" This program is free software; you can redistribute it and/or modify
8 .\" it under the terms of the GNU General Public License as published by
9 .\" the Free Software Foundation; either version 2 of the License, or
10 .\" (at your option) any later version.
11 .\"
12 .\" This program is distributed in the hope that it will be useful,
13 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
14 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 .\" GNU Library General Public License for more details.
16 .\"
17 .\" You should have received a copy of the GNU General Public License along
18 .\" with this program; if not, write to the Free Software Foundation,
19 .\" Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 .\"
21 .TH ATOOL "1" "August 8, 2009" "atool"
22 .\" Read this file with groff -man -Tascii atool.1
23 .SH NAME
24 atool \- A script for managing file archives of various types
25 .SH SYNOPSIS
26 .B atool
27 .RI [ OPTION ]... " ARCHIVE " [ FILE ]...
28 .br
29 .B aunpack
30 .RI [ OPTION ]... " ARCHIVE " [ FILE ]...
31 .br
32 .B apack
33 .RI [ OPTION ]... " ARCHIVE " [ FILE ]...
34 .br
35 .B als
36 .RI [ OPTION ]... " ARCHIVE " [ FILE ]...
37 .br
38 .B acat
39 .RI [ OPTION ]... " ARCHIVE " [ FILE ]...
40 .br
41 .B adiff
42 .RI [ OPTION ]... " ARCHIVE " "" ARCHIVE
43 .br
44 .B arepack
45 .RI [ OPTION ]... " OLD-ARCHIVE " "" NEW-ARCHIVE
46 .SH DESCRIPTION
47 This manual page document describes the \fBatool\fP commands.
48 These commands are used for managing file archives of various
49 types, such as tar and Zip archives. Each command can be
50 executed individually or by giving the appropriate options
51 to \fBatool\fP (see \fBOPTIONS\fP below).
52 .PP
53 \fBaunpack\fP extracts files from an archive. Often one wants
54 to extract all files in an archive to a single subdirectory.
55 However, some archives contain multiple files in their root
56 directories. The aunpack program overcomes this problem by
57 first extracting files to a unique (temporary) directory, and
58 then moving its contents back if possible. This also prevents
59 local files from being overwritten by mistake.
60 .PP
61 \fBapack\fP creates archives (or compresses files). If no file
62 arguments are specified, filenames to add are read from standard in.
63 .PP
64 \fBals\fP lists files in an archive.
65 .PP
66 \fBacat\fP extracts files in an archive to standard out.
67 .PP
68 \fBadiff\fP generates a diff between two archives using
69 diff(1).
70 .PP
71 \fBarepack\fP repacks archives to a different format. It does
72 this by first extracting all files of the old archive into a
73 temporary directory, then packing all files extracted to
74 that directory to the new archive. Use the \-\-each (\-e) option in
75 combination with \-\-format (\-F) to repack multiple archives using a
76 single invocation of atool. Note that arepack will not remove the old
77 archive.
78 .PP
79 Unless the \fB\-\-format\fP (\fB\-F\fP) option is provided,
80 the archive format is determined by the archive file extension. I.e.
81 an extension ".tar.gz" or ".tgz" means tar+gzip format. Note that
82 the extensions are checked in the order listed in the section
83 \fBARCHIVE TYPES\fP below, which is why a file with extension ".tar.gz"
84 is considered to a be tar+gzip archive, not a gzip compressed file.
85 .SH OPTIONS
86 These programs follow the usual GNU command line syntax, with long
87 options starting with two dashes (`-').
88 A summary of options is included below.
89 .TP
90 .B \-l, \-\-list
91 List files in archive.
92 This option is automatically assumed when \fBals\fP is executed.
93 .TP
94 .B \-x, \-\-extract
95 Extract files from archive.
96 This option is automatically assumed when \fBaunpack\fP is executed.
97 .TP
98 .B \-X, \-\-extract-to\fR=\fIPATH\fR
99 Extract files from archive to the specified directory. When
100 unpacking compressed files, PATH may refer to either a filename
101 or an existing directory.
103 .B \-a, \-\-add
104 Create archive.
105 This option is automatically assumed when \fBapack\fP is executed.
107 .B \-c, \-\-cat
108 Extract a file from archive to standard out (displaying it on
109 screen).
110 This option is automatically assumed when \fBacat\fP is executed.
112 .B \-d, \-\-diff
113 Extract two archives and use diff(1) to generate differencies
114 between them.
115 This option is automatically assumed when \fBadiff\fP is executed.
117 .B \-e, \-\-each
118 For each argument, execute the specified command. This can be used
119 to quickly extract, list or create multiple archives (see \fBEXAMPLES\fR
120 below). This option can not be used with the cat command.
122 .B \-F, \-\-format\fR=\fIEXTENSION\fR
123 Specify archive format manually (see \fBARCHIVE TYPES\fR below).
125 .B \-S, \-\-simulate
126 Run atool in simulation mode. No changes to the filesystem
127 (i.e. writes) will be made, and all commands that would be
128 executed are displayed instead. This option can't be combined
129 with \fB\-\-explain\fP (since it implies that already).
131 Note that it is not guaranteed that the commands printed in
132 simulation mode will be the same as those executed in non-
133 simulation mode. This is because some operations depend on
134 what files archives contain, and atool can at this time
135 only determine that by extracting archives.
137 .B \-E, \-\-explain
138 Display commands executed by atool. This option can't be combined
139 with \fB\-\-simulate\fP.
141 .B \-p, \-\-page
142 Run output through a pager, usually \fBpager\fP unless the environment
143 variable \fBPAGER\fP is set.
145 .B \-f, \-\-force
146 When extracting from files, allow overwriting of local files.
147 When creating an archive, allow the archive file to be overwritten
148 if it already exists. Note that it is possible to add files to
149 existing RAR and Zip archives (this is not possible for many
150 other formats).
152 .B \-D, \-\-subdir
153 When extracting archives, always create a new directory for
154 the archive even if the archive only contains one file in
155 its root directory.
157 .B \-0, \-\-null
158 If no file arguments are specified when creating or adding files
159 to archives, the list of files will be read from standard in.
160 Normally these filenames are separated by newline, but with this
161 option they are separated by null-bytes. This is useful with the
162 GNU find \-print0 option.
164 .B \-q, \-\-quiet
165 Decrease verbosity level by one. This is subtracted from the
166 default verbosity level, or the level specified
167 with \fB\-\-verbosity\fP. This option may be specified more than
168 once to make atool even less verbose.
170 .B \-v, \-\-verbose
171 Increase verbosity level by one. This is added to the
172 default verbosity level, or the level specified
173 with \fB\-\-verbosity\fP. This option may be specified more than
174 once to make atool even more verbose.
176 .B \-V, \-\-verbosity\fR=\fILEVEL\fR
177 Specify verbosity level. The default level is 1,
178 which means "normal verbosity" - e.g. when creating and
179 extracting from archives, files will be listed.
181 .B \-\-config\fR=\fIFILE\fR
182 Load configuration from the specified file. When using this
183 option, the system-wide and user-wide configuration files
184 will not be loaded. If the specified file does not exist or
185 can not be read, atool will terminate with an error message.
187 .B \-o, \-\-option\fR=\fIKEY=VALUE\fR
188 Override a configuration option. These are applied after
189 reading the configuration files.
191 You can specify this multiple times to override different options.
194 .B \-O, \-\-format\-option\fR=\fIOPTION\fR
195 Send additional options to the archiver command. This can be useful
196 when specifying compression options for some archives, e.g.
198         \fBapack \-F7z \-O-mx=9 archive.7z dir\fP
200 You can specify this multiple times add different options.
202 .B \-\-save\-outdir\fR=\fIFILE\fR
203 When extracting files, save the name of the directory which
204 the archive was extracted to to the specified file. If the
205 command was not `extract', or the archive was not extracted to
206 a new directory, then nothing will be written to the specified
207 file. If multiple archives were specified (with \-e), then
208 only the last directory that files were extracted to will be
209 written to FILE.
211 This option is used internally (see \fBEXAMPLES\fR below).
213 .B \-\-help
214 Show summary of options.
216 .B \-\-version
217 Output version information and exit.
218 .SH ARCHIVE TYPES
219 Unless the \-f (\-\-format) option is provided, the archive format
220 is determined by the archive file extension. I.e. an extension
221 ".tar.gz" or ".tgz" means tar+gzip format. Note that the extensions
222 are checked in the other listed above, which is why a file
223 with extension ".tar.gz" is considered to a tar+gzip archive,
224 not a gzip archive.
226 The diff command is supported whenever the extract command is
227 supported.
229 The supported archive types are:
231 .RI \fBtar+gzip\fP " " ( .tar.gz ", " .tgz )
232 All commands are supported.
234 .RI \fBtar+bzip\fP " " ( .tar.bz ", " .tbz )
235 All commands are supported.
237 .RI \fBtar+bzip2\fP " " ( .tar.bz2 ", " .tbz2 )
238 All commands are supported.
240 .RI \fBtar+compress\fP " " ( .tar.Z ", " .tZ )
241 All commands are supported.
243 .RI \fBtar+lzop\fP " " ( .tar.lzo ", " .tzo )
244 All commands are supported.
246 .RI \fBtar+lzip\fP " " ( .tar.lz ", " .tlz )
247 All commands are supported.
249 .RI \fBtar+xz\fP " " ( .tar.xz ", " .txz )
250 All commands are supported.
252 .RI \fBtar+7z\fP " " ( .tar.7z ", " .t7z )
253 All commands are supported.
255 .RI \fBtar\fP " " ( .tar )
256 All commands are supported.
258 .RI \fBzip\fP " " ( .zip )
259 All commands are supported.
261 .RI \fBjar\fP " " ( .jar ", " .war )
262 List, extract, and add commands are supported.
263 Cat is supported if use_jar_program is disabled.
265 .RI \fBrar\fP " " ( .rar )
266 All commands are supported.
268 .RI \fBlha\fP " " ( .lha ", " .lzh )
269 All commands are supported.
271 .RI \fB7z\fP " " ( .7z )
272 Extract, list and add commands are supported.
274 .RI \fBalzip\fP " " ( .alz )
275 Extract command is supported.
277 .RI \fBace\fP " " ( .ace )
278 Extract and list commands are supported.
280 .RI \fBar\fP " " ( .a )
281 All commands are supported.
283 .RI \fBarj\fP " " ( .arj )
284 List, extract and add commands are supported.
286 .RI \fBarc\fP " " ( .arc )
287 All command are supported.
288 (Note that arc outputs an extra newline when the cat command is used.)
290 .RI \fBrpm\fP " " ( .rpm )
291 Extract and list commands are supported.
293 .RI \fBdeb\fP " " ( .deb )
294 Extract and list commands are supported.
296 .RI \fBcab\fP " " ( .cab )
297 Cat, extract, and list commands are supported.
299 .RI \fBgzip\fP " " ( .gz )
300 Cat, extract, and add commands are supported.
302 .RI \fBbzip\fP " " ( .bz )
303 Cat, extract, and add commands are supported.
305 .RI \fBbzip2\fP " " ( .bz2 )
306 Cat, extract, and add commands are supported.
308 .RI \fBcompress\fP " " ( .Z )
309 Cat, extract, and add commands are supported.
311 .RI \fBlzma\fP " " ( .lzma )
312 Cat, extract, and add commands are supported.
314 .RI \fBlzop\fP " " ( .lzo )
315 Extract and add commands are supported. The cat command is not supported
316 because lzop does not want to extract files to standard out unless the \-f
317 flag is given.
319 .RI \fBlzip\fP " " ( .lz )
320 Cat, extract, and add commands are supported.
322 .RI \fBxz\fP " " ( .xz )
323 Cat, extract, and add commands are supported.
325 .RI \fBrzip\fP " " ( .rz )
326 Extract and add commands are supported.
328 .RI \fBlrzip\fP " " ( .lrz )
329 Extract and add commands are supported.
331 .RI \fB7zip\fP " " ( .7z )
332 All commands are supported.
333 (Note that 7z refuses to write extracted files to standard out
334 if standard out is a terminal. Use \-p or pipe the output
335 of atool/acat to a pager when reading in a terminal.)
337 .RI \fBcpio\fP " " ( .cpio )
338 List, extract and add commands are supported.
341 .SH CONFIGURATION
342 Since version 0.8.0, atool can read custom configuration files.
343 First, hardcoded defaults in the atool program file are evaluated.
344 Then system-wide configuration values are loaded from
345 \fI/etc/atool.conf\fR if that file exists. Finally, per-user
346 configuration values are loaded from \fI.atoolrc\fR in the current
347 user's home directory.
349 The format of the configuration files is simple:
351 variable value
353 Here \fBvariable\fR is a variable listed below, and \fBvalue\fR is the
354 value to associate the variable with. \fBvariable\fR and \fBvalue\fR
355 should be separated with at least one whitespace (space, tab etc). Empty
356 lines and lines beginning with # are discarded.
358 A value of `1' means that the option is enabled, and `0'
359 that it is disabled. Strings should not be quoted, as they start at
360 the first non-whitespace character and end at the end of the line.
362 The options are:
364 .B use_tar_bzip2_option \fR(default: 1)\fR
365 Enable this if you use GNU tar and it supports the \fB\-\-bzip2\fP option
366 for filtering bzip2'ed files through bzip2. Versions 1.13.6
367 or later of GNU tar support \fB\-\-bzip2\fP. Therefore, if you use
368 GNU tar earlier than 1.13.6, you will need to disable this option.
370 This used to be \fBuse_tar_j_option\fP but using \-\-bzip2 is more portable.
372 .B use_tar_lzip_option \fR(default: 0)\fR
373 Enable this if you use GNU tar and it supports the \fB\-\-lzip\fP option
374 for filtering lzip'ed files through lzip. Versions 1.23
375 or later of GNU tar support \fB\-\-lzip\fP. Therefore, if you use
376 GNU tar earlier than 1.23, you will need to disable this option.
378 .B use_tar_z_option \fR(default: 1)\fR
379 Enable this if you use GNU tar and it supports the \fB\-z\fP option
380 for filtering gzipped files through gzip. You will need to disable
381 this and \fIuse_tar_j_option\fR if you don't use GNU tar.
383 Disabling these two options doesn't mean that atool can't
384 extract bzip2/gzip files. If disabled, atool use a pipe to
385 send output from bzip2/gzip to tar instead.
387 If possible, these options should be enabled since error
388 management is better when filtering is done by tar.
390 .B use_tar_lzma_option \fR(default: 1)\fR
391 Enable this if you use GNU tar and it supports the \fB\-\-lzma\fP option
392 for filtering lzma compressed files through lzma. Versions 1.20
393 or later of GNU tar support \fB\-\-lzma\fP.
395 .B use_tar_lzop_option \fR(default: 0)\fR
396 Enable this if you use GNU tar and it supports the \fB\-\-lzop\fP option
397 for filtering lzop compressed files through lzop. Versions 1.21
398 or later of GNU tar support \fB\-\-lzop\fP.
400 .B use_tar_xz_option \fR(default: 0)\fR
401 Enable this if you use GNU tar and it supports the \fB\-\-xz\fP option
402 for filtering xz compressed files through xz. Versions 1.22
403 or later of GNU tar support \fB\-\-xz\fP.
405 .B use_gzip_for_z \fR(default: 1)\fR
406 Enable this if you want to use gzip instead of uncompress when
407 decompressing compress'ed files (`.Z' files).
409 .B use_rar_for_unpack \fR(default: 0)\fR
410 Enable this if you want to always use rar instead of unrar
411 when possible. This makes atool use the rar command
412 (path_rar) even when listing and extracting RAR files.
414 .B use_arc_for_unpack \fR(default: 0)\fR
415 Enable this if you want to always use arc instead of nomarch
416 when possible. This makes atool use the arc command
417 (path_arc) even when listing and extracting ARC files.
419 .B use_arj_for_unpack \fR(default: 0)\fR
420 Enable this if you want to always use arj instead of unarj
421 when possible. This makes atool use the arj command
422 (path_arj) even when listing and extracting ARJ files.
424 .B use_find_cpio_print0 \fR(default: 1)\fR
425 Enable this if find supports the \-print0 option and cpio supports
426 the \-0 option. Without it, it is impossible/harder to make cpio
427 archives of files with newline characters in their names.
429 .B extract_deb_control \fR(default: 1)\fR
430 Debian .deb package files contain control information in a DEBIAN
431 directory, especially the package's "control" file. Enable this if
432 you want the control information to be exctracted during extraction in
433 addition to the normal files.
435 .B strip_unknown_ext \fR(default: 1)\fR
436 Certain types of files are actually archives, but their extensions
437 doesn't tell so. Examples are Open Office documents (Zip files) and
438 Gnumeric documents (gzip'ed files). Since the extensions of those
439 filenames are unknown to atool, they would not be stripped with
440 this option set to 0. The output file in that case would be something
441 like Unpack-XYZW. Setting this option to 1 will cause the extension
442 to be stripped instead.
444 .B use_pbzip2 \fR(default: 0)\fR
445 Enable this if you want to use pbzip2 rather than bzip2.
446 Please not that if use_tar_bzip2_option is enabled, then
447 bzip2 will be used by tar regardless of the use_pbzip2
448 option. So if you want tar to use pbzip2 rather than bzip2,
449 set use_pbzip2 to 1 and use_tar_bzip2_option to 0.
451 .B use_lbzip2 \fR(default: 0)\fR
452 Enable this if you want to use lbzip2 rather than bzip2.
453 Please not that if use_tar_bzip2_option is enabled, then
454 bzip2 will be used by tar regardless of the use_lbzip2
455 option. So if you want tar to use lbzip2 rather than bzip2,
456 set use_lbzip2 to 1 and use_tar_bzip2_option to 0.
458 .B use_pigz \fR(default: 0)\fR
459 Enable this if you want to use pigz rather than gzip.
460 Please not that if use_tar_z_option is enabled, then
461 gzip will be used by tar regardless of the use_pigz
462 option. So if you want tar to use pigz rather than gzip,
463 set use_pigz to 1 and use_tar_z_option to 0.
465 .B use_plzip \fR(default: 0)\fR
466 Enable this if you want to use plzip rather than lzip.
467 Please not that if use_tar_lzip_option is enabled, then
468 lzip will be used by tar regardless of the use_plzip
469 option. So if you want tar to use plzip rather than lzip,
470 set use_plzip to 1 and use_tar_lzip_option to 0.
472 .B use_jar \fR(default: 0)\fR
473 Enable this if you want to use jar for managing jar
474 archives. If you disable this option, zip will be
475 used (which should work just as well, and probably be
476 faster too).
478 This option is disabled by default since extracting
479 files to standard out (`cat') is not supported by jar.
481 .B use_file \fR(default: 1)\fR
482 Enable this if you want atool to identify file types
483 using file(1) for those files with an unrecognized
484 extension (or none at all).
486 .B use_file_always \fR(default: 0)\fR
487 Enable this if you want atool to always identify archives
488 using file(1), regardless of the file extension. Please note
489 that this currently has some drawbacks, such as not being able
490 to identify all archive types (especially tar archives compressed
491 with 7zip, lzop, szip etc).
493 .B tmpdir_name \fR(default: Unpack-%04d)\fR
494 atool extracts to a temporary directory created in the current
495 directory so that no files are overwritten. This variable
496 controlls what name that temporary directory should have.
498 The `%d' string in this variable will be replaced with a random
499 number between 0 and 9999. It is possible change the format
500 of this number by using something else than `%d' - see printf(3).
502 .B tmpfile_name \fR(default: Pack-%04d)\fR
503 When using pbzip2, and creating archives, a temporary file need
504 to be created. This option controls the name of that file.
505 See tmpdir_name for further details on the format.
507 .B path_pager \fR(default: pager)\fR
509 .B path_jar \fR(default: jar)\fR
511 .B path_tar \fR(default: tar)\fR
513 .B path_zip \fR(default: zip)\fR
515 .B path_unzip \fR(default: unzip)\fR
517 .B path_gzip \fR(default: gzip)\fR
519 .B path_bzip \fR(default: bzip)\fR
521 .B path_bzip2 \fR(default: bzip2)\fR
523 .B path_pbzip2 \fR(default: pbzip2)\fR
525 .B path_compress \fR(default: compress)\fR
527 .B path_lzma \fR(default: lzma)\fR
529 .B path_lzop \fR(default: lzop)\fR
531 .B path_lzip \fR(default: lzip)\fR
533 .B path_rar \fR(default: rar)\fR
535 .B path_unrar \fR(default: unrar)\fR
537 .B path_lbzip2 \fR(default: lbzip2)\fR
539 .B path_pigz \fR(default: pigz)\fR
541 .B path_cabextract \fR(default: cabextract)\fR
543 .B path_7z \fR(default: 7z)\fR
545 .B path_unalz \fR(default: unalz)\fR
547 .B path_lha \fR(default: lha)\fR
549 .B path_unace \fR(default: unace)\fR
551 .B path_ar \fR(default: ar)\fR
553 .B path_arj \fR(default: arj)\fR
555 .B path_unarj \fR(default: unarj)\fR
557 .B path_arc \fR(default: arc)\fR
559 .B path_nomarch \fR(default: nomarch)\fR
561 .B path_rpm \fR(default: rpm)\fR
563 .B path_rpm2cpio \fR(default: rpm2cpio)\fR
565 .B path_dpkg_deb \fR(default: dpkg-deb)\fR
567 .B path_cpio \fR(default: cpio)\fR
569 .B path_file \fR(default: file)\fR
571 .B path_find \fR(default: find)\fR
573 .B path_xargs \fR(default: xargs)\fR
575 .B path_cat \fR(default: cat)\fR
577 .B path_diff \fR(default: diff)\fR
578 These are all paths to the corresponding programs. It is usually
579 best to leave them as is, because that way their locations can be
580 looked up from the PATH variable.
582 .B args_diff \fR(default: \-ru)\fR
583 This variable specifies command line arguments to pass to the
584 diff command (as specified by path_diff) when using adiff. Space
585 characters separate arguments in this string.
587 .B path_syscfg \fR(default: /etc/atool.conf)\fR
588 (This variable can only be set in the atool program file.)
589 This variable specifies the directory where the system-wide
590 configuration file is located.
592 .B path_usercfg \fR(default: .atoolrc)\fR
593 (This variable can only be set in the atool program file
594 and system-wide configuration file.)
595 This variable specifies where the user configuration file
596 is located. Note that if this filename is relative (i.e. doesn't
597 being with `/'), it will be relative to the current user's home
598 directory (as determined by the HOME environment variable).
600 .B default_verbosity \fR(default: 1)\fR
601 This is the default verbosity of atool. By using \-q and \-v
602 options, the verbosity level can be raised and lowered.
603 Level 1 means "normal verbosity" - e.g. when creating and
604 extracting from archives, files will be listed.
606 .B show_extracted \fR(default: 1)\fR
607 If this is set to 1, the aunpack command will always show
608 what file or directory that was extracted. Otherwise
609 that will only be printed if the archive was extracted to
610 an unexpected location (as a result of local files already
611 existing or the archive having multiple files in its root
612 directory).
614 This can be quite useful in combinatiaon with `default_verbosity 0'.
615 Note that this option will have no effect when the \-X option is used
616 with aunpack, and it has no effect on compressed files.
618 .B keep_compressed \fR(default: 1)\fR
619 When compressing a file with gzip or bzip2, the original (uncompressed)
620 file is usually deleted once it has been compressed. I.e. if you
621 compress a file "test" you will end up with only one file, "test.gz".
622 With this option set to 1, you will make atool keep the original file
623 as well. The original behaviour is achieved by setting this option to 0.
625 This option also has an equivalent effect on uncompressing compressed
626 files. When set to 1, the original (compressed) file will be kept.
627 Otherwise it will be deleted.
629 Note however that this option has no effect when packing up a compressed
630 file with the \-X option (for specifying an output directory or file). In
631 that case the original file is always kept.
633 .B decompress_to_cwd \fR(default: 1)\fR
634 When decompressing a file with commands such as gzip or bzip2, the
635 decompressed file is usually placed in the same directory as the
636 compressed file. With this option set to 1, the decompressed file is
637 instead placed in the current working directory.
639 Note that this option has no effect when \-X is used.
641 .SH ENVIRONMENT VARIABLES
642 .B PAGER
643 The default pager to use when the \-p/\-\-page option is specified.
644 .SH EXAMPLES
645 To extract all files from archive `foobar.tar.gz' to a subdirectory
646 (or the current directory if it only contains one file):
648         \fBaunpack foobar.tar.gz\fP
650 To extract all files from all `.tar.gz' archives in the
651 current directory:
653         \fBaunpack \-e *.tar.gz\fP
655 To create a zip archive of two files `foo' and `bar':
657         \fBapack myarchive.zip foo bar\fP
659 To display the file `baz' in the archive `myarchive.zip'
660 through a pager:
662         \fBacat \-p myarchive.zip baz\fP
664 To list contents of the rar archive `stuff.rar':
666         \fBals stuff.rar\fP
668 To create three archives, `dir1.tar.gz', `dir2.tar.gz' and `dir3.tar.gz',
669 so that the first one contains all files in dir1, the second all
670 in dir2 and the third all dir3:
672         \fBapack \-e \-F .tar.gz dir1 dir2 dir3\fP
674 To show all differences between version 2.4.17 and 2.4.18 of the kernel:
676         \fBadiff linux-2.4.17.tar.gz linux-2.4.18.tar.gz\fP
678 To repack all .tar.gz archives in the current directory to .tar.7z (the
679 old archive will be kept untouched):
681         \fBarepack \-F.tar.7z \-e *.tar.gz\fP
683 Here's a shell function that will make the aunpack command change into the
684 directory where files were extracted:
686         \fBaunpack () {\fP
688         \fB  TMP=`mktemp /tmp/aunpack.XXXXXXXXXX`\fP
690         \fB  atool \-x \-\-save-outdir=$TMP "$@"\fP
692         \fB  DIR="`cat $TMP`"\fP
694         \fB  [ "$DIR" != "" \-a \-d "$DIR" ] && cd "$DIR"\fP
696         \fB  rm $TMP\fP
698         \fB}\fP
700 If you don't have the mktemp program, you can replace the second line with
701 (note however that this is not entirely safe)
703         \fB  TMP="/tmp/atool_outdir.$$"\fP
705 .SH KNOWN BUGS
706 Trying to extract gzip and other compressed files without the .gz (or .bz2
707 etc) extension won't work:
709   aunpack: foo: format not known, identifying using file
710   aunpack: foo: format is `gzip'
711   gzip: foo: unknown suffix -- ignored
713 This last error above is generated by \fBgzip \-d foo\fP.
715 If you find a bug not listed here, please report it to <@PACKAGE_BUGREPORT@>.
716 .SH REPORTING BUGS
717 Report bugs to <\fIoskar@osk.mine.nu\fP>.
718 .SH AUTHOR
719 The author of \fBatool\fP and this manual page is Oskar Liljeblad <\fIoskar@osk.mine.nu\fP>.
720 .SH COPYRIGHT
721 Copyright \(co 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2011, 2012 Oskar Liljeblad
723 This is free software; see the source for copying conditions.  There is NO
724 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.