1 .\" Copyright (c) 2003-2007 Tim Kientzle
2 .\" Copyright (c) 2017 Martin Matuska
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd manipulate tape archives
36 .Op Ar bundled-flags Ao args Ac
37 .Op Ao Ar file Ac | Ao Ar pattern Ac ...
41 .Op Ar files | Ar directories
46 .Op Ar files | Ar directories
53 creates and manipulates streaming archive files.
54 This implementation can extract from tar, pax, cpio, zip, jar, ar, xar,
55 rpm, 7-zip, and ISO 9660 cdrom images and can create tar, pax, cpio, ar, zip,
56 7-zip, and shar archives.
58 The first synopsis form shows a
61 This usage is provided for compatibility with historical implementations.
62 See COMPATIBILITY below for details.
64 The other synopsis forms show the preferred usage.
67 is a mode indicator from the following list:
68 .Bl -tag -compact -width indent
70 Create a new archive containing the specified items.
71 The long option form is
76 but new entries are appended to the archive.
77 Note that this only works on uncompressed archives stored in regular files.
81 The long option form is
84 List archive contents to stdout.
85 The long option form is
90 but new entries are added only if they have a modification date
91 newer than the corresponding entry in the archive.
92 Note that this only works on uncompressed archives stored in regular files.
99 Extract to disk from the archive.
100 If a file with the same name appears more than once in the archive,
101 each copy will be extracted, with later copies overwriting (replacing)
103 The long option form is
112 mode, each specified file or directory is added to the
113 archive in the order specified on the command line.
114 By default, the contents of each directory are also archived.
116 In extract or list mode, the entire command line
117 is read and parsed before the archive is opened.
118 The pathnames or patterns on the command line indicate
119 which items in the archive should be processed.
120 Patterns are shell-style globbing patterns as
124 Unless specifically stated otherwise, options are applicable in
126 .Bl -tag -width indent
127 .It Cm @ Ns Pa archive
129 The specified archive is opened and the entries
130 in it will be appended to the current archive.
132 .Dl Nm Fl c Fl f Pa - Pa newfile Cm @ Ns Pa original.tar
133 writes a new archive to standard output containing a file
135 and all of the entries from
138 .Dl Nm Fl c Fl f Pa - Pa newfile Pa original.tar
139 creates a new archive with only two entries.
141 .Dl Nm Fl czf Pa - Fl Fl format Cm pax Cm @ Ns Pa -
142 reads an archive from standard input (whose format will be determined
143 automatically) and converts it into a gzip-compressed
144 pax-format archive on stdout.
147 can be used to convert archives from one format to another.
148 .It Fl a , Fl Fl auto-compress
150 Use the archive suffix to decide a set of the format and
153 .Dl Nm Fl a Fl cf Pa archive.tgz source.c source.h
154 creates a new archive with restricted pax format and gzip compression,
155 .Dl Nm Fl a Fl cf Pa archive.tar.bz2.uu source.c source.h
156 creates a new archive with restricted pax format and bzip2 compression
157 and uuencode compression,
158 .Dl Nm Fl a Fl cf Pa archive.zip source.c source.h
159 creates a new archive with zip format,
160 .Dl Nm Fl a Fl jcf Pa archive.tgz source.c source.h
163 option, and creates a new archive with restricted pax format
164 and gzip compression,
165 .Dl Nm Fl a Fl jcf Pa archive.xxx source.c source.h
166 if it is unknown suffix or no suffix, creates a new archive with
167 restricted pax format and bzip2 compression.
169 (c, r, u, x modes only)
170 Archive or extract POSIX.1e or NFSv4 ACLs. This is the reverse of
172 and the default behavior in c, r, and u modes (except on Mac OS X) or if
174 is run in x mode as root. On Mac OS X this option translates extended ACLs
175 to NFSv4 ACLs. To store extended ACLs the
178 .It Fl B , Fl Fl read-full-blocks
179 Ignored for compatibility with other
182 .It Fl b Ar blocksize , Fl Fl block-size Ar blocksize
183 Specify the block size, in 512-byte records, for tape drive I/O.
184 As a rule, this argument is only needed when reading from or writing
185 to tape drives, and usually not even then as the default block size of
186 20 records (10240 bytes) is very common.
187 .It Fl C Ar directory , Fl Fl cd Ar directory , Fl Fl directory Ar directory
188 In c and r mode, this changes the directory before adding
190 In x mode, change directories after opening the archive
191 but before extracting entries from the archive.
195 to the current directory after processing any
197 options and before extracting any files.
198 .It Fl Fl clear-nochange-fflags
200 Before removing file system objects to replace them, clear platform-specific
201 file flags that might prevent removal.
202 .It Fl Fl exclude Ar pattern
203 Do not process files or directories that match the
205 Note that exclusions take precedence over patterns or filenames
206 specified on the command line.
208 (c, r, u, x modes only)
209 Archive or extract file flags. This is the reverse of
211 and the default behavior in c, r, and u modes or if
213 is run in x mode as root.
214 .It Fl Fl format Ar format
216 Use the specified format for the created archive.
217 Supported formats include
223 Other formats may also be supported; see
224 .Xr libarchive-formats 5
225 for more information about currently-supported formats.
226 In r and u modes, when extending an existing archive, the format specified
227 here must be compatible with the format of the existing archive on disk.
228 .It Fl f Ar file , Fl Fl file Ar file
229 Read the archive from or write the archive to the specified file.
232 for standard input or standard output.
233 The default varies by system;
238 on Linux, the default is
241 Use the provided group id number.
242 On extract, this overrides the group id in the archive;
243 the group name in the archive will be ignored.
244 On create, this overrides the group id read from disk;
247 is not also specified, the group name will be set to
249 .It Fl Fl gname Ar name
250 Use the provided group name.
251 On extract, this overrides the group name in the archive;
252 if the provided group name does not exist on the system,
254 (from the archive or from the
257 will be used instead.
258 On create, this sets the group name that will be stored
260 the name will not be verified against the system group database.
263 Symbolic links named on the command line will be followed; the
264 target of the link will be archived, not the link itself.
274 .It Fl Fl hfsCompression
276 Mac OS X specific (v10.6 or later). Compress extracted regular files with HFS+
278 .It Fl Fl ignore-zeros
280 .Fl Fl options Cm read_concatenated_archives
281 for compatibility with GNU tar.
282 .It Fl Fl include Ar pattern
283 Process only files or directories that match the specified pattern.
284 Note that exclusions specified with
286 take precedence over inclusions.
287 If no inclusions are explicitly specified, all entries are processed by
291 option is especially useful when filtering archives.
292 For example, the command
293 .Dl Nm Fl c Fl f Pa new.tar Fl Fl include='*foo*' Cm @ Ns Pa old.tgz
294 creates a new archive
296 containing only the entries from
298 containing the string
302 Compress the resulting archive with
304 In extract or list modes, this option is ignored.
305 Note that, unlike other
307 implementations, this implementation recognizes XZ compression
308 automatically when reading archives.
309 .It Fl j , Fl Fl bzip , Fl Fl bzip2 , Fl Fl bunzip2
311 Compress the resulting archive with
313 In extract or list modes, this option is ignored.
314 Note that, unlike other
316 implementations, this implementation recognizes bzip2 compression
317 automatically when reading archives.
318 .It Fl k , Fl Fl keep-old-files
320 Do not overwrite existing files.
321 In particular, if a file appears more than once in an archive,
322 later copies will not overwrite earlier copies.
323 .It Fl Fl keep-newer-files
325 Do not overwrite existing files that are newer than the
326 versions appearing in the archive being extracted.
327 .It Fl L , Fl Fl dereference
329 All symbolic links will be followed.
330 Normally, symbolic links are archived as such.
331 With this option, the target of the link will be archived instead.
332 .It Fl l , Fl Fl check-links
334 Issue a warning message unless all links to each file are archived.
337 Compress the resulting archive with
339 In extract or list modes, this option is ignored.
342 Compress the archive with lz4-compatible compression before writing it.
343 In input mode, this option is ignored; lz4 compression is recognized
344 automatically on input.
346 (c mode only) Compress the resulting archive with the original LZMA algorithm.
347 Use of this option is discouraged and new archives should be created with
350 Note that, unlike other
352 implementations, this implementation recognizes LZMA compression
353 automatically when reading archives.
356 Compress the resulting archive with
358 In extract or list modes, this option is ignored.
359 .It Fl m , Fl Fl modification-time
361 Do not extract modification time.
362 By default, the modification time is set to the time stored in the archive.
363 .It Fl Fl mac-metadata
364 (c, r, u and x mode only)
365 Mac OS X specific. Archive or extract extended ACLs and extended attributes
368 in AppleDouble format. This is the reverse of
369 .Fl Fl no-mac-metadata .
370 and the default behavior in c, r, and u modes or if
372 is run in x mode as root.
373 .It Fl n , Fl Fl norecurse , Fl Fl no-recursion
375 Do not recursively archive the contents of directories.
376 .It Fl Fl newer Ar date
378 Only include files and directories newer than the specified date.
379 This compares ctime entries.
380 .It Fl Fl newer-mtime Ar date
384 except it compares mtime entries instead of ctime entries.
385 .It Fl Fl newer-than Pa file
387 Only include files and directories newer than the specified file.
388 This compares ctime entries.
389 .It Fl Fl newer-mtime-than Pa file
393 except it compares mtime entries instead of ctime entries.
396 Honor the nodump file flag by skipping this file.
397 .It Fl Fl nopreserveHFSCompression
399 Mac OS X specific (v10.6 or later). Do not compress extracted regular files
400 which were compressed with HFS+ compression before archived.
401 By default, compress the regular files again with HFS+ compression.
407 Filenames or patterns are separated by null characters,
409 This is often used to read filenames output by the
414 (c, r, u, x modes only)
415 Do not archive or extract POSIX.1e or NFSv4 ACLs. This is the reverse of
417 and the default behavior if
419 is run as non-root in x mode (on Mac OS X as any user in c, r, u and x modes).
421 (c, r, u, x modes only)
422 Do not archive or extract file flags. This is the reverse of
424 and the default behavior if
426 is run as non-root in x mode.
427 .It Fl Fl no-mac-metadata
429 Mac OS X specific. Do not archive or extract ACLs and extended attributes using
431 in AppleDouble format. This is the reverse of
432 .Fl Fl mac-metadata .
433 and the default behavior if
435 is run as non-root in x mode.
436 .It Fl n , Fl Fl norecurse , Fl Fl no-recursion
437 .It Fl Fl no-same-owner
439 Do not extract owner and group IDs.
440 This is the reverse of
442 and the default behavior if
445 .It Fl Fl no-same-permissions
447 Do not extract full permissions (SGID, SUID, sticky bit, ACLs,
448 extended attributes or extended file flags).
449 This is the reverse of
451 and the default behavior if
455 (c, r, u, x modes only)
456 Do not archive or extract extended attributes. This is the reverse of
458 and the default behavior if
460 is run as non-root in x mode.
461 .It Fl Fl numeric-owner
462 This is equivalent to
467 On extract, it causes user and group names in the archive
468 to be ignored in favor of the numeric user and group ids.
469 On create, it causes user and group names to not be stored
471 .It Fl O , Fl Fl to-stdout
473 In extract (-x) mode, files will be written to standard out rather than
474 being extracted to disk.
475 In list (-t) mode, the file listing will be written to stderr rather than
479 Use the user and group of the user running the program rather
480 than those specified in the archive.
481 Note that this has no significance unless
483 is specified, and the program is being run by the root user.
484 In this case, the file modes and flags from
485 the archive will be restored, but ACLs or owner information in
486 the archive will be discarded.
490 .Fl Fl format Ar ustar
491 .It Fl Fl older Ar date
493 Only include files and directories older than the specified date.
494 This compares ctime entries.
495 .It Fl Fl older-mtime Ar date
499 except it compares mtime entries instead of ctime entries.
500 .It Fl Fl older-than Pa file
502 Only include files and directories older than the specified file.
503 This compares ctime entries.
504 .It Fl Fl older-mtime-than Pa file
508 except it compares mtime entries instead of ctime entries.
509 .It Fl Fl one-file-system
511 Do not cross mount points.
512 .It Fl Fl options Ar options
513 Select optional behaviors for particular modules.
514 The argument is a text string containing comma-separated
516 These are passed to the modules that handle particular
517 formats to control how those formats will behave.
518 Each option has one of the following forms:
519 .Bl -tag -compact -width indent
521 The key will be set to the specified value in every module that supports it.
522 Modules that do not support this key will ignore it.
524 The key will be enabled in every module that supports it.
525 This is equivalent to
528 The key will be disabled in every module that supports it.
529 .It Ar module:key=value , Ar module:key , Ar module:!key
530 As above, but the corresponding key and value will be provided
531 only to modules whose name matches
534 The currently supported modules and keys are:
535 .Bl -tag -compact -width indent
536 .It Cm iso9660:joliet
537 Support Joliet extensions.
538 This is enabled by default, use
543 .It Cm iso9660:rockridge
544 Support Rock Ridge extensions.
545 This is enabled by default, use
548 .Cm iso9660:!rockridge
550 .It Cm gzip:compression-level
551 A decimal integer from 1 to 9 specifying the gzip compression level.
552 .It Cm gzip:timestamp
553 Store timestamp. This is enabled by default, use
558 .It Cm lrzip:compression Ns = Ns Ar type
561 as compression method.
562 Supported values are bzip2, gzip, lzo (ultra fast),
563 and zpaq (best, extremely slow).
564 .It Cm lrzip:compression-level
565 A decimal integer from 1 to 9 specifying the lrzip compression level.
566 .It Cm lz4:compression-level
567 A decimal integer from 1 to 9 specifying the lzop compression level.
568 .It Cm lz4:stream-checksum
569 Enable stream checksum. This is by default, use
570 .Cm lz4:!stream-checksum
572 .It Cm lz4:block-checksum
573 Enable block checksum (Disabled by default).
574 .It Cm lz4:block-size
575 A decimal integer from 4 to 7 specifying the lz4 compression block size
576 (7 is set by default).
577 .It Cm lz4:block-dependence
578 Use the previous block of the block being compressed for
579 a compression dictionary to improve compression ratio.
580 .It Cm lzop:compression-level
581 A decimal integer from 1 to 9 specifying the lzop compression level.
582 .It Cm xz:compression-level
583 A decimal integer from 0 to 9 specifying the xz compression level.
584 .It Cm mtree: Ns Ar keyword
585 The mtree writer module allows you to specify which mtree keywords
586 will be included in the output.
587 Supported keywords include:
588 .Cm cksum , Cm device , Cm flags , Cm gid , Cm gname , Cm indent ,
589 .Cm link , Cm md5 , Cm mode , Cm nlink , Cm rmd160 , Cm sha1 , Cm sha256 ,
590 .Cm sha384 , Cm sha512 , Cm size , Cm time , Cm uid , Cm uname .
591 The default is equivalent to:
592 .Dq device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname .
594 Enables all of the above keywords.
597 to disable all keywords.
603 Produce human-readable output by indenting options and splitting lines
604 to fit into 80 columns.
605 .It Cm zip:compression Ns = Ns Ar type
608 as compression method.
609 Supported values are store (uncompressed) and deflate (gzip algorithm).
610 .It Cm zip:encryption
611 Enable encryption using traditional zip encryption.
612 .It Cm zip:encryption Ns = Ns Ar type
616 Supported values are zipcrypt (traditional zip encryption),
617 aes128 (WinZip AES-128 encryption) and aes256 (WinZip AES-256 encryption).
618 .It Cm read_concatenated_archives
619 Ignore zeroed blocks in the archive, which occurs when multiple tar archives
620 have been concatenated together. Without this option, only the contents of
621 the first concatenated archive would be read. This option is comparable to
623 .Fl i , Fl Fl ignore-zeros
626 If a provided option is not supported by any module, that
628 .It Fl P , Fl Fl absolute-paths
630 By default, absolute pathnames (those that begin with a /
631 character) have the leading slash removed both when creating archives
632 and extracting from them.
635 will refuse to extract archive entries whose pathnames contain
637 or whose target directory would be altered by a symlink.
638 This option suppresses these behaviors.
639 .It Fl p , Fl Fl insecure , Fl Fl preserve-permissions
641 Preserve file permissions.
642 Attempt to restore the full permissions, including owner, file modes, ACLs,
643 extended attributes and extended file flags, if available, for each item
644 extracted from the archive. This is te reverse of
645 .Fl Fl no-same-permissions
648 is being run by root and can be partially overridden by also specifying
651 .Fl Fl no-mac-metadata
654 .It Fl Fl passphrase Ar passphrase
657 is used to extract or create an encrypted archive.
658 Currently, zip is the only supported format that supports encryption.
659 You shouldn't use this option unless you realize how insecure
660 use of this option is.
665 .It Fl q , Fl Fl fast-read
667 Extract or list only the first archive entry that matches each pattern
669 Exit as soon as each specified pattern or filename has been matched.
670 By default, the archive is always read to the very end, since
671 there can be multiple entries with the same name and, by convention,
672 later entries overwrite earlier entries.
673 This option is provided as a performance optimization.
676 Extract files as sparse files.
677 For every block on disk, check first if it contains only NULL bytes and seek
679 This works similar to the conv=sparse option of dd.
681 Modify file or archive member names according to
683 The pattern has the format
684 .Ar /old/new/ Ns Op ghHprRsS
687 is a basic regular expression,
689 is the replacement string of the matched part,
690 and the optional trailing letters modify
691 how the replacement is handled.
694 is not matched, the pattern is skipped.
697 ~ is substituted with the match, \e1 to \e9 with the content of
698 the corresponding captured group.
699 The optional trailing g specifies that matching should continue
700 after the matched part and stop on the first unmatched pattern.
701 The optional trailing s specifies that the pattern applies to the value
703 The optional trailing p specifies that after a successful substitution
704 the original path name and the new path name should be printed to
706 Optional trailing H, R, or S characters suppress substitutions
707 for hardlink targets, regular filenames, or symlink targets,
709 Optional trailing h, r, or s characters enable substitutions
710 for hardlink targets, regular filenames, or symlink targets,
714 which applies substitutions to all names.
715 In particular, it is never necessary to specify h, r, or s.
718 Extract owner and group IDs.
719 This is the reverse of
721 and the default behavior if
724 .It Fl Fl strip-components Ar count
725 Remove the specified number of leading path elements.
726 Pathnames with fewer elements will be silently skipped.
727 Note that the pathname is edited after checking inclusion/exclusion patterns
728 but before security checks.
729 .It Fl T Ar filename , Fl Fl files-from Ar filename
732 will read the list of names to be extracted from
736 will read names to be archived from
740 on a line by itself will cause the current directory to be changed to
741 the directory specified on the following line.
742 Names are terminated by newlines unless
747 also disables the special handling of lines containing
749 Note: If you are generating lists of files using
751 you probably want to use
756 After archiving all files, print a summary to stderr.
757 .It Fl U , Fl Fl unlink , Fl Fl unlink-first
759 Unlink files before creating them.
760 This can be a minor performance optimization if most files
761 already exist, but can make things slower if most files
762 do not already exist.
763 This flag also causes
765 to remove intervening directory symlinks instead of
767 See the SECURITY section below for more details.
769 Use the provided user id number and ignore the user
770 name from the archive.
773 is not also specified, the user name will be set to
775 .It Fl Fl uname Ar name
776 Use the provided user name.
777 On extract, this overrides the user name in the archive;
778 if the provided user name does not exist on the system,
779 it will be ignored and the user id
780 (from the archive or from the
783 will be used instead.
784 On create, this sets the user name that will be stored
786 the name is not verified against the system user database.
787 .It Fl Fl use-compress-program Ar program
788 Pipe the input (in x or t mode) or the output (in c mode) through
790 instead of using the builtin compression support.
791 .It Fl v , Fl Fl verbose
792 Produce verbose output.
793 In create and extract modes,
795 will list each file name as it is read from or written to
799 will produce output similar to that of
803 option will also provide ls-like details in create and extract mode.
810 .It Fl w , Fl Fl confirmation , Fl Fl interactive
811 Ask for confirmation for every action.
812 .It Fl X Ar filename , Fl Fl exclude-from Ar filename
813 Read a list of exclusion patterns from the specified file.
816 for more information about the handling of exclusions.
818 (c, r, u, x modes only)
819 Archive or extract extended attributes. This is the reverse of
821 and the default behavior in c, r, and u modes or if
823 is run in x mode as root.
826 Compress the resulting archive with
828 In extract or list modes, this option is ignored.
829 Note that, unlike other
831 implementations, this implementation recognizes bzip2 compression
832 automatically when reading archives.
833 .It Fl Z , Fl Fl compress , Fl Fl uncompress
835 Compress the resulting archive with
837 In extract or list modes, this option is ignored.
838 Note that, unlike other
840 implementations, this implementation recognizes compress compression
841 automatically when reading archives.
842 .It Fl z , Fl Fl gunzip , Fl Fl gzip
844 Compress the resulting archive with
846 In extract or list modes, this option is ignored.
847 Note that, unlike other
849 implementations, this implementation recognizes gzip compression
850 automatically when reading archives.
853 The following environment variables affect the execution of
855 .Bl -tag -width ".Ev BLOCKSIZE"
856 .It Ev TAR_READER_OPTIONS
857 The default options for format readers and compression readers.
860 option overrides this.
861 .It Ev TAR_WRITER_OPTIONS
862 The default options for format writers and compression writers.
865 option overrides this.
870 for more information.
875 option overrides this.
876 Please see the description of the
878 option above for more details.
880 The timezone to use when displaying dates.
883 for more information.
888 The following creates a new archive
891 that contains two files
895 .Dl Nm Fl czf Pa file.tar.gz Pa source.c Pa source.h
897 To view a detailed table of contents for this
899 .Dl Nm Fl tvf Pa file.tar.gz
901 To extract all entries from the archive on
902 the default tape drive:
905 To examine the contents of an ISO 9660 cdrom image:
906 .Dl Nm Fl tf Pa image.iso
908 To move file hierarchies, invoke
911 .Dl Nm Fl cf Pa - Fl C Pa srcdir\ . | Nm Fl xpf Pa - Fl C Pa destdir
912 or more traditionally
913 .Dl cd srcdir \&; Nm Fl cf Pa -\ . | ( cd destdir \&; Nm Fl xpf Pa - )
915 In create mode, the list of files and directories to be archived
916 can also include directory change instructions of the form
918 and archive inclusions of the form
919 .Cm @ Ns Pa archive-file .
920 For example, the command line
921 .Dl Nm Fl c Fl f Pa new.tar Pa foo1 Cm @ Ns Pa old.tgz Cm -C Ns Pa /tmp Pa foo2
922 will create a new archive
927 from the current directory and add it to the output archive.
928 It will then read each entry from
930 and add those entries to the output archive.
931 Finally, it will switch to the
935 to the output archive.
939 format can be used to create an output archive with arbitrary ownership,
940 permissions, or names that differ from existing data on disk:
942 .Bd -literal -offset indent
945 usr/bin uid=0 gid=0 mode=0755 type=dir
946 usr/bin/ls uid=0 gid=0 mode=0755 type=file content=myls
947 $ tar -cvf output.tar @input.mtree
954 switches accept a variety of common date and time specifications, including
955 .Dq 12 Mar 2005 7:14:29pm ,
956 .Dq 2005-03-12 19:14 ,
959 .Dq 19:14 PST May 1 .
963 argument can be used to control various details of archive generation
965 For example, you can generate mtree output which only contains
970 .Dl Nm Fl cf Pa file.tar Fl Fl format=mtree Fl Fl options='!all,type,time,uid' Pa dir
971 or you can set the compression level used by gzip or xz compression:
972 .Dl Nm Fl czf Pa file.tar Fl Fl options='compression-level=9' .
973 For more details, see the explanation of the
974 .Fn archive_read_set_options
976 .Fn archive_write_set_options
977 API calls that are described in
980 .Xr archive_write 3 .
982 The bundled-arguments format is supported for compatibility
983 with historic implementations.
984 It consists of an initial word (with no leading - character) in which
985 each character indicates an option.
986 Arguments follow as separate words.
987 The order of the arguments must match the order
988 of the corresponding characters in the bundled command word.
990 .Dl Nm Cm tbf 32 Pa file.tar
991 specifies three flags
1000 flags both require arguments,
1001 so there must be two additional items
1002 on the command line.
1005 is the argument to the
1009 is the argument to the
1013 The mode options c, r, t, u, and x and the options
1014 b, f, l, m, o, v, and w comply with SUSv2.
1016 For maximum portability, scripts that invoke
1018 should use the bundled-argument format above, should limit
1033 Additional long options are provided to improve compatibility with other
1034 tar implementations.
1036 Certain security issues are common to many archiving programs, including
1038 In particular, carefully-crafted archives can request that
1040 extract files to locations outside of the target directory.
1041 This can potentially be used to cause unwitting users to overwrite
1042 files they did not intend to overwrite.
1043 If the archive is being extracted by the superuser, any file
1044 on the system can potentially be overwritten.
1045 There are three ways this can happen.
1048 has mechanisms to protect against each one,
1049 savvy users should be aware of the implications:
1050 .Bl -bullet -width indent
1052 Archive entries can have absolute pathnames.
1057 character from filenames before restoring them to guard against this problem.
1059 Archive entries can have pathnames that include
1064 will not extract files containing
1066 components in their pathname.
1068 Archive entries can exploit symbolic links to restore
1069 files to other directories.
1070 An archive can restore a symbolic link to another directory,
1071 then use that link to restore a file into that directory.
1072 To guard against this,
1074 checks each extracted path for symlinks.
1075 If the final path element is a symlink, it will be removed
1076 and replaced with the archive entry.
1079 is specified, any intermediate symlink will also be unconditionally removed.
1086 will refuse to extract the entry.
1088 To protect yourself, you should be wary of any archives that
1089 come from untrusted sources.
1090 You should examine the contents of an archive with
1091 .Dl Nm Fl tf Pa filename
1095 option to ensure that
1097 will not overwrite any existing files or the
1099 option to remove any pre-existing files.
1100 You should generally not extract archives while running with super-user
1106 disables the security checks above and allows you to extract
1107 an archive while preserving any absolute pathnames,
1109 components, or symlinks to other directories.
1120 .Xr libarchive-formats 5 ,
1123 There is no current POSIX standard for the tar command; it appeared
1126 but was dropped from
1128 The options supported by this implementation were developed by surveying a
1129 number of existing tar implementations as well as the old POSIX specification
1130 for tar and the current POSIX specification for pax.
1132 The ustar and pax interchange file formats are defined by
1134 for the pax command.
1138 command appeared in Seventh Edition Unix, which was released in January, 1979.
1139 There have been numerous other implementations,
1140 many of which extended the file format.
1143 public-domain implementation (circa November, 1987)
1144 was quite influential, and formed the basis of GNU tar.
1145 GNU tar was included as the standard system tar
1151 This is a complete re-implementation based on the
1154 It was first released with
1158 This program follows
1160 for the definition of the
1163 Note that GNU tar prior to version 1.15 treated
1165 as a synonym for the
1166 .Fl Fl one-file-system
1171 option may differ from historic implementations.
1173 All archive output is written in correctly-sized blocks, even
1174 if the output is being compressed.
1175 Whether or not the last output block is padded to a full
1176 block size varies depending on the format and the
1178 For tar and cpio formats, the last block of output is padded
1179 to a full block size if the output is being
1180 written to standard output or to a character or block device such as
1182 If the output is being written to a regular file, the last block
1184 Many compressors, including
1188 complain about the null padding when decompressing an archive created by
1190 although they still extract it correctly.
1192 The compression and decompression is implemented internally, so
1193 there may be insignificant differences between the compressed output
1195 .Dl Nm Fl czf Pa - file
1196 and that generated by
1197 .Dl Nm Fl cf Pa - file | Nm gzip
1199 The default should be to read and write archives to the standard I/O paths,
1200 but tradition (and POSIX) dictates otherwise.
1206 modes require that the archive be uncompressed
1207 and located in a regular file on disk.
1208 Other archives can be modified using
1214 To archive a file called
1218 you must specify it as
1224 In create mode, a leading
1229 is stripped unless the
1231 option is specified.
1233 There needs to be better support for file selection on both create
1236 There is not yet any support for multi-volume archives.
1238 Converting between dissimilar archive formats (such as tar and cpio) using the
1240 convention can cause hard link information to be lost.
1241 (This is a consequence of the incompatible ways that different archive
1242 formats store hardlink information.)