1 \input texinfo @c -*-texinfo-*-
2 @comment %**start of header
5 @settitle GNU tar @value{VERSION}
14 @c 1. Pay attention to @FIXME{}s and @UNREVISED{}s
15 @c 2. Before creating final variant:
16 @c 2.1. Run `make check-options' to make sure all options are properly
18 @c 2.2. Run `make master-menu' (see comment before the master menu).
20 @include rendition.texi
26 @c Put everything in one index (arbitrarily chosen to be the concept index).
35 This manual is for @acronym{GNU} @command{tar} (version
36 @value{VERSION}, @value{UPDATED}), which creates and extracts files
39 Copyright @copyright{} 1992, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
40 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
43 Permission is granted to copy, distribute and/or modify this document
44 under the terms of the GNU Free Documentation License, Version 1.1 or
45 any later version published by the Free Software Foundation; with no
46 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
47 and with the Back-Cover Texts as in (a) below. A copy of the license
48 is included in the section entitled "GNU Free Documentation License".
50 (a) The FSF's Back-Cover Text is: ``You have the freedom to
51 copy and modify this GNU manual. Buying copies from the FSF
52 supports it in developing GNU and promoting software freedom.''
56 @dircategory Archiving
58 * Tar: (tar). Making tape (or disk) archives.
61 @dircategory Individual utilities
63 * tar: (tar)tar invocation. Invoking @GNUTAR{}.
66 @shorttitlepage @acronym{GNU} @command{tar}
69 @title @acronym{GNU} tar: an archiver tool
70 @subtitle @value{RENDITION} @value{VERSION}, @value{UPDATED}
71 @author John Gilmore, Jay Fenlason et al.
74 @vskip 0pt plus 1filll
80 @top @acronym{GNU} tar: an archiver tool
85 @cindex archiving files
87 The first part of this master menu lists the major nodes in this Info
88 document. The rest of the menu lists all the lower level nodes.
91 @c The master menu goes here.
93 @c NOTE: To update it from within Emacs, make sure mastermenu.el is
94 @c loaded and run texinfo-master-menu.
95 @c To update it from the command line, run
106 * Date input formats::
113 * Configuring Help Summary::
114 * Fixing Snapshot Files::
117 * Free Software Needs Free Documentation::
118 * Copying This Manual::
119 * Index of Command Line Options::
123 --- The Detailed Node Listing ---
127 * Book Contents:: What this Book Contains
128 * Definitions:: Some Definitions
129 * What tar Does:: What @command{tar} Does
130 * Naming tar Archives:: How @command{tar} Archives are Named
131 * Authors:: @GNUTAR{} Authors
132 * Reports:: Reporting bugs or suggestions
134 Tutorial Introduction to @command{tar}
137 * stylistic conventions::
138 * basic tar options:: Basic @command{tar} Operations and Options
139 * frequent operations::
140 * Two Frequent Options::
141 * create:: How to Create Archives
142 * list:: How to List Archives
143 * extract:: How to Extract Members from an Archive
146 Two Frequently Used Options
152 How to Create Archives
154 * prepare for examples::
155 * Creating the archive::
164 How to Extract Members from an Archive
166 * extracting archives::
169 * extracting untrusted archives::
175 * using tar options::
185 The Three Option Styles
187 * Long Options:: Long Option Style
188 * Short Options:: Short Option Style
189 * Old Options:: Old Option Style
190 * Mixing:: Mixing Option Styles
192 All @command{tar} Options
194 * Operation Summary::
196 * Short Option Summary::
208 Advanced @GNUTAR{} Operations
217 How to Add Files to Existing Archives: @option{--append}
219 * appending files:: Appending Files to an Archive
226 Options Used by @option{--create}
228 * override:: Overriding File Metadata.
229 * Ignore Failed Read::
231 Options Used by @option{--extract}
233 * Reading:: Options to Help Read Archives
234 * Writing:: Changing How @command{tar} Writes Files
235 * Scarce:: Coping with Scarce Resources
237 Options to Help Read Archives
239 * read full records::
242 Changing How @command{tar} Writes Files
244 * Dealing with Old Files::
245 * Overwrite Old Files::
250 * Data Modification Times::
251 * Setting Access Permissions::
252 * Directory Modification Times and Permissions::
253 * Writing to Standard Output::
254 * Writing to an External Program::
257 Coping with Scarce Resources
262 Performing Backups and Restoring Files
264 * Full Dumps:: Using @command{tar} to Perform Full Dumps
265 * Incremental Dumps:: Using @command{tar} to Perform Incremental Dumps
266 * Backup Levels:: Levels of Backups
267 * Backup Parameters:: Setting Parameters for Backups and Restoration
268 * Scripted Backups:: Using the Backup Scripts
269 * Scripted Restoration:: Using the Restore Script
271 Setting Parameters for Backups and Restoration
273 * General-Purpose Variables::
274 * Magnetic Tape Control::
276 * backup-specs example:: An Example Text of @file{Backup-specs}
278 Choosing Files and Names for @command{tar}
280 * file:: Choosing the Archive's Name
281 * Selecting Archive Members::
282 * files:: Reading Names from a File
283 * exclude:: Excluding Some Files
284 * wildcards:: Wildcards Patterns and Matching
285 * quoting styles:: Ways of Quoting Special Characters in Names
286 * transform:: Modifying File and Member Names
287 * after:: Operating Only on New Files
288 * recurse:: Descending into Directories
289 * one:: Crossing File System Boundaries
291 Reading Names from a File
297 * problems with exclude::
299 Wildcards Patterns and Matching
301 * controlling pattern-matching::
303 Crossing File System Boundaries
305 * directory:: Changing Directory
306 * absolute:: Absolute File Names
310 * General date syntax:: Common rules.
311 * Calendar date items:: 19 Dec 1994.
312 * Time of day items:: 9:20pm.
313 * Time zone items:: @sc{est}, @sc{pdt}, @sc{gmt}.
314 * Day of week items:: Monday and others.
315 * Relative items in date strings:: next tuesday, 2 years ago.
316 * Pure numbers in date strings:: 19931219, 1440.
317 * Seconds since the Epoch:: @@1078100502.
318 * Specifying time zone rules:: TZ="America/New_York", TZ="UTC0".
319 * Authors of get_date:: Bellovin, Eggert, Salz, Berets, et al.
321 Controlling the Archive Format
323 * Compression:: Using Less Space through Compression
324 * Attributes:: Handling File Attributes
325 * Portability:: Making @command{tar} Archives More Portable
326 * cpio:: Comparison of @command{tar} and @command{cpio}
328 Using Less Space through Compression
330 * gzip:: Creating and Reading Compressed Archives
331 * sparse:: Archiving Sparse Files
333 Making @command{tar} Archives More Portable
335 * Portable Names:: Portable Names
336 * dereference:: Symbolic Links
337 * hard links:: Hard Links
338 * old:: Old V7 Archives
339 * ustar:: Ustar Archives
340 * gnu:: GNU and old GNU format archives.
341 * posix:: @acronym{POSIX} archives
342 * Checksumming:: Checksumming Problems
343 * Large or Negative Values:: Large files, negative time stamps, etc.
344 * Other Tars:: How to Extract GNU-Specific Data Using
345 Other @command{tar} Implementations
347 @GNUTAR{} and @acronym{POSIX} @command{tar}
349 * PAX keywords:: Controlling Extended Header Keywords.
351 How to Extract GNU-Specific Data Using Other @command{tar} Implementations
353 * Split Recovery:: Members Split Between Volumes
354 * Sparse Recovery:: Sparse Members
356 Tapes and Other Archive Media
358 * Device:: Device selection and switching
359 * Remote Tape Server::
360 * Common Problems and Solutions::
361 * Blocking:: Blocking
362 * Many:: Many archives on one tape
363 * Using Multiple Tapes:: Using Multiple Tapes
364 * label:: Including a Label in the Archive
370 * Format Variations:: Format Variations
371 * Blocking Factor:: The Blocking Factor of an Archive
373 Many Archives on One Tape
375 * Tape Positioning:: Tape Positions and Tape Marks
376 * mt:: The @command{mt} Utility
380 * Multi-Volume Archives:: Archives Longer than One Tape or Disk
381 * Tape Files:: Tape Files
382 * Tarcat:: Concatenate Volumes into a Single Archive
387 * Standard:: Basic Tar Format
388 * Extensions:: @acronym{GNU} Extensions to the Archive Format
389 * Sparse Formats:: Storing Sparse Files
396 * PAX 0:: PAX Format, Versions 0.0 and 0.1
397 * PAX 1:: PAX Format, Version 1.0
401 * Generate Mode:: File Generation Mode.
402 * Status Mode:: File Status Mode.
403 * Exec Mode:: Synchronous Execution mode.
407 * GNU Free Documentation License:: License for copying this manual
413 @chapter Introduction
416 and manipulates @dfn{archives} which are actually collections of
417 many other files; the program provides users with an organized and
418 systematic method for controlling a large amount of data.
419 The name ``tar'' originally came from the phrase ``Tape ARchive'', but
420 archives need not (and these days, typically do not) reside on tapes.
423 * Book Contents:: What this Book Contains
424 * Definitions:: Some Definitions
425 * What tar Does:: What @command{tar} Does
426 * Naming tar Archives:: How @command{tar} Archives are Named
427 * Authors:: @GNUTAR{} Authors
428 * Reports:: Reporting bugs or suggestions
432 @section What this Book Contains
434 The first part of this chapter introduces you to various terms that will
435 recur throughout the book. It also tells you who has worked on @GNUTAR{}
436 and its documentation, and where you should send bug reports
439 The second chapter is a tutorial (@pxref{Tutorial}) which provides a
440 gentle introduction for people who are new to using @command{tar}. It is
441 meant to be self contained, not requiring any reading from subsequent
442 chapters to make sense. It moves from topic to topic in a logical,
443 progressive order, building on information already explained.
445 Although the tutorial is paced and structured to allow beginners to
446 learn how to use @command{tar}, it is not intended solely for beginners.
447 The tutorial explains how to use the three most frequently used
448 operations (@samp{create}, @samp{list}, and @samp{extract}) as well as
449 two frequently used options (@samp{file} and @samp{verbose}). The other
450 chapters do not refer to the tutorial frequently; however, if a section
451 discusses something which is a complex variant of a basic concept, there
452 may be a cross reference to that basic concept. (The entire book,
453 including the tutorial, assumes that the reader understands some basic
454 concepts of using a Unix-type operating system; @pxref{Tutorial}.)
456 The third chapter presents the remaining five operations, and
457 information about using @command{tar} options and option syntax.
459 The other chapters are meant to be used as a reference. Each chapter
460 presents everything that needs to be said about a specific topic.
462 One of the chapters (@pxref{Date input formats}) exists in its
463 entirety in other @acronym{GNU} manuals, and is mostly self-contained.
464 In addition, one section of this manual (@pxref{Standard}) contains a
465 big quote which is taken directly from @command{tar} sources.
467 In general, we give both long and short (abbreviated) option names
468 at least once in each section where the relevant option is covered, so
469 that novice readers will become familiar with both styles. (A few
470 options have no short versions, and the relevant sections will
474 @section Some Definitions
478 The @command{tar} program is used to create and manipulate @command{tar}
479 archives. An @dfn{archive} is a single file which contains the contents
480 of many files, while still identifying the names of the files, their
481 owner(s), and so forth. (In addition, archives record access
482 permissions, user and group, size in bytes, and data modification time.
483 Some archives also record the file names in each archived directory, as
484 well as other file and directory information.) You can use @command{tar}
485 to @dfn{create} a new archive in a specified directory.
488 @cindex archive member
491 The files inside an archive are called @dfn{members}. Within this
492 manual, we use the term @dfn{file} to refer only to files accessible in
493 the normal ways (by @command{ls}, @command{cat}, and so forth), and the term
494 @dfn{member} to refer only to the members of an archive. Similarly, a
495 @dfn{file name} is the name of a file, as it resides in the file system,
496 and a @dfn{member name} is the name of an archive member within the
501 The term @dfn{extraction} refers to the process of copying an archive
502 member (or multiple members) into a file in the file system. Extracting
503 all the members of an archive is often called @dfn{extracting the
504 archive}. The term @dfn{unpack} can also be used to refer to the
505 extraction of many or all the members of an archive. Extracting an
506 archive does not destroy the archive's structure, just as creating an
507 archive does not destroy the copies of the files that exist outside of
508 the archive. You may also @dfn{list} the members in a given archive
509 (this is often thought of as ``printing'' them to the standard output,
510 or the command line), or @dfn{append} members to a pre-existing archive.
511 All of these operations can be performed using @command{tar}.
514 @section What @command{tar} Does
517 The @command{tar} program provides the ability to create @command{tar}
518 archives, as well as various other kinds of manipulation. For example,
519 you can use @command{tar} on previously created archives to extract files,
520 to store additional files, or to update or list files which were already
523 Initially, @command{tar} archives were used to store files conveniently on
524 magnetic tape. The name @command{tar} comes from this use; it stands for
525 @code{t}ape @code{ar}chiver. Despite the utility's name, @command{tar} can
526 direct its output to available devices, files, or other programs (using
527 pipes). @command{tar} may even access remote devices or files (as archives).
529 You can use @command{tar} archives in many ways. We want to stress a few
530 of them: storage, backup, and transportation.
532 @FIXME{the following table entries need a bit of work.}
535 Often, @command{tar} archives are used to store related files for
536 convenient file transfer over a network. For example, the
537 @acronym{GNU} Project distributes its software bundled into
538 @command{tar} archives, so that all the files relating to a particular
539 program (or set of related programs) can be transferred as a single
542 A magnetic tape can store several files in sequence. However, the tape
543 has no names for these files; it only knows their relative position on
544 the tape. One way to store several files on one tape and retain their
545 names is by creating a @command{tar} archive. Even when the basic transfer
546 mechanism can keep track of names, as FTP can, the nuisance of handling
547 multiple files, directories, and multiple links makes @command{tar}
550 Archive files are also used for long-term storage. You can think of
551 this as transportation from the present into the future. (It is a
552 science-fiction idiom that you can move through time as well as in
553 space; the idea here is that @command{tar} can be used to move archives in
554 all dimensions, even time!)
557 Because the archive created by @command{tar} is capable of preserving
558 file information and directory structure, @command{tar} is commonly
559 used for performing full and incremental backups of disks. A backup
560 puts a collection of files (possibly pertaining to many users and
561 projects) together on a disk or a tape. This guards against
562 accidental destruction of the information in those files.
563 @GNUTAR{} has special features that allow it to be
564 used to make incremental and full dumps of all the files in a
568 You can create an archive on one system, transfer it to another system,
569 and extract the contents there. This allows you to transport a group of
570 files from one system to another.
573 @node Naming tar Archives
574 @section How @command{tar} Archives are Named
576 Conventionally, @command{tar} archives are given names ending with
577 @samp{.tar}. This is not necessary for @command{tar} to operate properly,
578 but this manual follows that convention in order to accustom readers to
579 it and to make examples more clear.
584 Often, people refer to @command{tar} archives as ``@command{tar} files,'' and
585 archive members as ``files'' or ``entries''. For people familiar with
586 the operation of @command{tar}, this causes no difficulty. However, in
587 this manual, we consistently refer to ``archives'' and ``archive
588 members'' to make learning to use @command{tar} easier for novice users.
591 @section @GNUTAR{} Authors
593 @GNUTAR{} was originally written by John Gilmore,
594 and modified by many people. The @acronym{GNU} enhancements were
595 written by Jay Fenlason, then Joy Kendall, and the whole package has
596 been further maintained by Thomas Bushnell, n/BSG, Fran@,{c}ois
597 Pinard, Paul Eggert, and finally Sergey Poznyakoff with the help of
598 numerous and kind users.
600 We wish to stress that @command{tar} is a collective work, and owes much to
601 all those people who reported problems, offered solutions and other
602 insights, or shared their thoughts and suggestions. An impressive, yet
603 partial list of those contributors can be found in the @file{THANKS}
604 file from the @GNUTAR{} distribution.
606 @FIXME{i want all of these names mentioned, Absolutely. BUT, i'm not
607 sure i want to spell out the history in this detail, at least not for
608 the printed book. i'm just not sure it needs to be said this way.
609 i'll think about it.}
611 @FIXME{History is more important, and surely more interesting, than
612 actual names. Quoting names without history would be meaningless. FP}
614 Jay Fenlason put together a draft of a @GNUTAR{}
615 manual, borrowing notes from the original man page from John Gilmore.
616 This was withdrawn in version 1.11. Thomas Bushnell, n/BSG and Amy
617 Gorin worked on a tutorial and manual for @GNUTAR{}.
618 Fran@,{c}ois Pinard put version 1.11.8 of the manual together by
619 taking information from all these sources and merging them. Melissa
620 Weisshaus finally edited and redesigned the book to create version
621 1.12. The book for versions from 1.14 up to @value{VERSION} were edited
622 by the current maintainer, Sergey Poznyakoff.
624 For version 1.12, Daniel Hagerty contributed a great deal of technical
625 consulting. In particular, he is the primary author of @ref{Backups}.
627 In July, 2003 @GNUTAR{} was put on CVS at savannah.gnu.org
628 (see @url{http://savannah.gnu.org/projects/tar}), and
629 active development and maintenance work has started
630 again. Currently @GNUTAR{} is being maintained by Paul Eggert, Sergey
631 Poznyakoff and Jeff Bailey.
633 Support for @acronym{POSIX} archives was added by Sergey Poznyakoff.
636 @section Reporting bugs or suggestions
639 @cindex reporting bugs
640 If you find problems or have suggestions about this program or manual,
641 please report them to @file{bug-tar@@gnu.org}.
643 When reporting a bug, please be sure to include as much detail as
644 possible, in order to reproduce it. @FIXME{Be more specific, I'd
645 like to make this node as detailed as 'Bug reporting' node in Emacs
649 @chapter Tutorial Introduction to @command{tar}
651 This chapter guides you through some basic examples of three @command{tar}
652 operations: @option{--create}, @option{--list}, and @option{--extract}. If
653 you already know how to use some other version of @command{tar}, then you
654 may not need to read this chapter. This chapter omits most complicated
655 details about how @command{tar} works.
659 * stylistic conventions::
660 * basic tar options:: Basic @command{tar} Operations and Options
661 * frequent operations::
662 * Two Frequent Options::
663 * create:: How to Create Archives
664 * list:: How to List Archives
665 * extract:: How to Extract Members from an Archive
670 @section Assumptions this Tutorial Makes
672 This chapter is paced to allow beginners to learn about @command{tar}
673 slowly. At the same time, we will try to cover all the basic aspects of
674 these three operations. In order to accomplish both of these tasks, we
675 have made certain assumptions about your knowledge before reading this
676 manual, and the hardware you will be using:
680 Before you start to work through this tutorial, you should understand
681 what the terms ``archive'' and ``archive member'' mean
682 (@pxref{Definitions}). In addition, you should understand something
683 about how Unix-type operating systems work, and you should know how to
684 use some basic utilities. For example, you should know how to create,
685 list, copy, rename, edit, and delete files and directories; how to
686 change between directories; and how to figure out where you are in the
687 file system. You should have some basic understanding of directory
688 structure and how files are named according to which directory they are
689 in. You should understand concepts such as standard output and standard
690 input, what various definitions of the term @samp{argument} mean, and the
691 differences between relative and absolute file names. @FIXME{and what
695 This manual assumes that you are working from your own home directory
696 (unless we state otherwise). In this tutorial, you will create a
697 directory to practice @command{tar} commands in. When we show file names,
698 we will assume that those names are relative to your home directory.
699 For example, my home directory is @file{/home/fsf/melissa}. All of
700 my examples are in a subdirectory of the directory named by that file
701 name; the subdirectory is called @file{practice}.
704 In general, we show examples of archives which exist on (or can be
705 written to, or worked with from) a directory on a hard disk. In most
706 cases, you could write those archives to, or work with them on any other
707 device, such as a tape drive. However, some of the later examples in
708 the tutorial and next chapter will not work on tape drives.
709 Additionally, working with tapes is much more complicated than working
710 with hard disks. For these reasons, the tutorial does not cover working
711 with tape drives. @xref{Media}, for complete information on using
712 @command{tar} archives with tape drives.
714 @FIXME{this is a cop out. need to add some simple tape drive info.}
717 @node stylistic conventions
718 @section Stylistic Conventions
720 In the examples, @samp{$} represents a typical shell prompt. It
721 precedes lines you should type; to make this more clear, those lines are
722 shown in @kbd{this font}, as opposed to lines which represent the
723 computer's response; those lines are shown in @code{this font}, or
724 sometimes @samp{like this}.
726 @c When we have lines which are too long to be
727 @c displayed in any other way, we will show them like this:
729 @node basic tar options
730 @section Basic @command{tar} Operations and Options
732 @command{tar} can take a wide variety of arguments which specify and define
733 the actions it will have on the particular set of files or the archive.
734 The main types of arguments to @command{tar} fall into one of two classes:
735 operations, and options.
737 Some arguments fall into a class called @dfn{operations}; exactly one of
738 these is both allowed and required for any instance of using @command{tar};
739 you may @emph{not} specify more than one. People sometimes speak of
740 @dfn{operating modes}. You are in a particular operating mode when you
741 have specified the operation which specifies it; there are eight
742 operations in total, and thus there are eight operating modes.
744 The other arguments fall into the class known as @dfn{options}. You are
745 not required to specify any options, and you are allowed to specify more
746 than one at a time (depending on the way you are using @command{tar} at
747 that time). Some options are used so frequently, and are so useful for
748 helping you type commands more carefully that they are effectively
749 ``required''. We will discuss them in this chapter.
751 You can write most of the @command{tar} operations and options in any
752 of three forms: long (mnemonic) form, short form, and old style. Some
753 of the operations and options have no short or ``old'' forms; however,
754 the operations and options which we will cover in this tutorial have
755 corresponding abbreviations. We will indicate those abbreviations
756 appropriately to get you used to seeing them. (Note that the ``old
757 style'' option forms exist in @GNUTAR{} for compatibility with Unix
758 @command{tar}. In this book we present a full discussion of this way
759 of writing options and operations (@pxref{Old Options}), and we discuss
760 the other two styles of writing options (@xref{Long Options}, and
761 @pxref{Short Options}).
763 In the examples and in the text of this tutorial, we usually use the
764 long forms of operations and options; but the ``short'' forms produce
765 the same result and can make typing long @command{tar} commands easier.
766 For example, instead of typing
769 @kbd{tar --create --verbose --file=afiles.tar apple angst aspic}
775 @kbd{tar -c -v -f afiles.tar apple angst aspic}
781 @kbd{tar -cvf afiles.tar apple angst aspic}
785 For more information on option syntax, see @ref{Advanced tar}. In
786 discussions in the text, when we name an option by its long form, we
787 also give the corresponding short option in parentheses.
789 The term, ``option'', can be confusing at times, since ``operations''
790 are often lumped in with the actual, @emph{optional} ``options'' in certain
791 general class statements. For example, we just talked about ``short and
792 long forms of options and operations''. However, experienced @command{tar}
793 users often refer to these by shorthand terms such as, ``short and long
794 options''. This term assumes that the ``operations'' are included, also.
795 Context will help you determine which definition of ``options'' to use.
797 Similarly, the term ``command'' can be confusing, as it is often used in
798 two different ways. People sometimes refer to @command{tar} ``commands''.
799 A @command{tar} @dfn{command} is the entire command line of user input
800 which tells @command{tar} what to do --- including the operation, options,
801 and any arguments (file names, pipes, other commands, etc.). However,
802 you will also sometimes hear the term ``the @command{tar} command''. When
803 the word ``command'' is used specifically like this, a person is usually
804 referring to the @command{tar} @emph{operation}, not the whole line.
805 Again, use context to figure out which of the meanings the speaker
808 @node frequent operations
809 @section The Three Most Frequently Used Operations
811 Here are the three most frequently used operations (both short and long
812 forms), as well as a brief description of their meanings. The rest of
813 this chapter will cover how to use these operations in detail. We will
814 present the rest of the operations in the next chapter.
819 Create a new @command{tar} archive.
822 List the contents of an archive.
825 Extract one or more members from an archive.
828 @node Two Frequent Options
829 @section Two Frequently Used Options
831 To understand how to run @command{tar} in the three operating modes listed
832 previously, you also need to understand how to use two of the options to
833 @command{tar}: @option{--file} (which takes an archive file as an argument)
834 and @option{--verbose}. (You are usually not @emph{required} to specify
835 either of these options when you run @command{tar}, but they can be very
836 useful in making things more clear and helping you avoid errors.)
845 @unnumberedsubsec The @option{--file} Option
848 @xopindex{file, tutorial}
849 @item --file=@var{archive-name}
850 @itemx -f @var{archive-name}
851 Specify the name of an archive file.
854 You can specify an argument for the @option{--file=@var{archive-name}} (@option{-f @var{archive-name}}) option whenever you
855 use @command{tar}; this option determines the name of the archive file
856 that @command{tar} will work on.
859 If you don't specify this argument, then @command{tar} will examine
860 the environment variable @env{TAPE}. If it is set, its value will be
861 used as the archive name. Otherwise, @command{tar} will use the
862 default archive, determined at the compile time. Usually it is
863 standard output or some physical tape drive attached to your machine
864 (you can verify what the default is by running @kbd{tar
865 --show-defaults}, @pxref{defaults}). If there is no tape drive
866 attached, or the default is not meaningful, then @command{tar} will
867 print an error message. The error message might look roughly like one
871 tar: can't open /dev/rmt8 : No such device or address
872 tar: can't open /dev/rsmt0 : I/O error
876 To avoid confusion, we recommend that you always specify an archive file
877 name by using @option{--file=@var{archive-name}} (@option{-f @var{archive-name}}) when writing your @command{tar} commands.
878 For more information on using the @option{--file=@var{archive-name}} (@option{-f @var{archive-name}}) option, see
881 @node verbose tutorial
882 @unnumberedsubsec The @option{--verbose} Option
885 @xopindex{verbose, introduced}
888 Show the files being worked on as @command{tar} is running.
891 @option{--verbose} (@option{-v}) shows details about the results of running
892 @command{tar}. This can be especially useful when the results might not be
893 obvious. For example, if you want to see the progress of @command{tar} as
894 it writes files into the archive, you can use the @option{--verbose}
895 option. In the beginning, you may find it useful to use
896 @option{--verbose} at all times; when you are more accustomed to
897 @command{tar}, you will likely want to use it at certain times but not at
898 others. We will use @option{--verbose} at times to help make something
899 clear, and we will give many examples both using and not using
900 @option{--verbose} to show the differences.
902 Each instance of @option{--verbose} on the command line increases the
903 verbosity level by one, so if you need more details on the output,
906 When reading archives (@option{--list}, @option{--extract},
907 @option{--diff}), @command{tar} by default prints only the names of
908 the members being extracted. Using @option{--verbose} will show a full,
909 @command{ls} style member listing.
911 In contrast, when writing archives (@option{--create}, @option{--append},
912 @option{--update}), @command{tar} does not print file names by
913 default. So, a single @option{--verbose} option shows the file names
914 being added to the archive, while two @option{--verbose} options
915 enable the full listing.
917 For example, to create an archive in verbose mode:
920 $ @kbd{tar -cvf afiles.tar apple angst aspic}
927 Creating the same archive with the verbosity level 2 could give:
930 $ @kbd{tar -cvvf afiles.tar apple angst aspic}
931 -rw-r--r-- gray/staff 62373 2006-06-09 12:06 apple
932 -rw-r--r-- gray/staff 11481 2006-06-09 12:06 angst
933 -rw-r--r-- gray/staff 23152 2006-06-09 12:06 aspic
937 This works equally well using short or long forms of options. Using
938 long forms, you would simply write out the mnemonic form of the option
942 $ @kbd{tar --create --verbose --verbose @dots{}}
946 Note that you must double the hyphens properly each time.
948 Later in the tutorial, we will give examples using @w{@option{--verbose
951 @anchor{verbose member listing}
952 The full output consists of six fields:
955 @item File type and permissions in symbolic form.
956 These are displayed in the same format as the first column of
957 @command{ls -l} output (@pxref{What information is listed,
958 format=verbose, Verbose listing, fileutils, GNU file utilities}).
960 @item Owner name and group separated by a slash character.
961 If these data are not available (for example, when listing a @samp{v7} format
962 archive), numeric @acronym{ID} values are printed instead.
964 @item Size of the file, in bytes.
966 @item File modification date in ISO 8601 format.
968 @item File modification time.
971 If the name contains any special characters (white space, newlines,
972 etc.) these are displayed in an unambiguous form using so called
973 @dfn{quoting style}. For the detailed discussion of available styles
974 and on how to use them, see @ref{quoting styles}.
976 Depending on the file type, the name can be followed by some
977 additional information, described in the following table:
980 @item -> @var{link-name}
981 The file or archive member is a @dfn{symbolic link} and
982 @var{link-name} is the name of file it links to.
984 @item link to @var{link-name}
985 The file or archive member is a @dfn{hard link} and @var{link-name} is
986 the name of file it links to.
989 The archive member is an old GNU format long link. You will normally
993 The archive member is an old GNU format long name. You will normally
996 @item --Volume Header--
997 The archive member is a GNU @dfn{volume header} (@pxref{Tape Files}).
999 @item --Continued at byte @var{n}--
1000 Encountered only at the beginning of a multi-volume archive
1001 (@pxref{Using Multiple Tapes}). This archive member is a continuation
1002 from the previous volume. The number @var{n} gives the offset where
1003 the original file was split.
1005 @item unknown file type @var{c}
1006 An archive member of unknown type. @var{c} is the type character from
1007 the archive header. If you encounter such a message, it means that
1008 either your archive contains proprietary member types @GNUTAR{} is not
1009 able to handle, or the archive is corrupted.
1014 For example, here is an archive listing containing most of the special
1015 suffixes explained above:
1019 V--------- 0/0 1536 2006-06-09 13:07 MyVolume--Volume Header--
1020 -rw-r--r-- gray/staff 456783 2006-06-09 12:06 aspic--Continued at
1022 -rw-r--r-- gray/staff 62373 2006-06-09 12:06 apple
1023 lrwxrwxrwx gray/staff 0 2006-06-09 13:01 angst -> apple
1024 -rw-r--r-- gray/staff 35793 2006-06-09 12:06 blues
1025 hrw-r--r-- gray/staff 0 2006-06-09 12:06 music link to blues
1033 @unnumberedsubsec Getting Help: Using the @option{--help} Option
1039 The @option{--help} option to @command{tar} prints out a very brief list of
1040 all operations and option available for the current version of
1041 @command{tar} available on your system.
1045 @section How to Create Archives
1048 @cindex Creation of the archive
1049 @cindex Archive, creation of
1050 One of the basic operations of @command{tar} is @option{--create} (@option{-c}), which
1051 you use to create a @command{tar} archive. We will explain
1052 @option{--create} first because, in order to learn about the other
1053 operations, you will find it useful to have an archive available to
1056 To make this easier, in this section you will first create a directory
1057 containing three files. Then, we will show you how to create an
1058 @emph{archive} (inside the new directory). Both the directory, and
1059 the archive are specifically for you to practice on. The rest of this
1060 chapter and the next chapter will show many examples using this
1061 directory and the files you will create: some of those files may be
1062 other directories and other archives.
1064 The three files you will archive in this example are called
1065 @file{blues}, @file{folk}, and @file{jazz}. The archive is called
1066 @file{collection.tar}.
1068 This section will proceed slowly, detailing how to use @option{--create}
1069 in @code{verbose} mode, and showing examples using both short and long
1070 forms. In the rest of the tutorial, and in the examples in the next
1071 chapter, we will proceed at a slightly quicker pace. This section
1072 moves more slowly to allow beginning users to understand how
1073 @command{tar} works.
1076 * prepare for examples::
1077 * Creating the archive::
1083 @node prepare for examples
1084 @subsection Preparing a Practice Directory for Examples
1086 To follow along with this and future examples, create a new directory
1087 called @file{practice} containing files called @file{blues}, @file{folk}
1088 and @file{jazz}. The files can contain any information you like:
1089 ideally, they should contain information which relates to their names,
1090 and be of different lengths. Our examples assume that @file{practice}
1091 is a subdirectory of your home directory.
1093 Now @command{cd} to the directory named @file{practice}; @file{practice}
1094 is now your @dfn{working directory}. (@emph{Please note}: Although
1095 the full file name of this directory is
1096 @file{/@var{homedir}/practice}, in our examples we will refer to
1097 this directory as @file{practice}; the @var{homedir} is presumed.
1099 In general, you should check that the files to be archived exist where
1100 you think they do (in the working directory) by running @command{ls}.
1101 Because you just created the directory and the files and have changed to
1102 that directory, you probably don't need to do that this time.
1104 It is very important to make sure there isn't already a file in the
1105 working directory with the archive name you intend to use (in this case,
1106 @samp{collection.tar}), or that you don't care about its contents.
1107 Whenever you use @samp{create}, @command{tar} will erase the current
1108 contents of the file named by @option{--file=@var{archive-name}} (@option{-f @var{archive-name}}) if it exists. @command{tar}
1109 will not tell you if you are about to overwrite an archive unless you
1110 specify an option which does this (@pxref{backup}, for the
1111 information on how to do so). To add files to an existing archive,
1112 you need to use a different option, such as @option{--append} (@option{-r}); see
1113 @ref{append} for information on how to do this.
1115 @node Creating the archive
1116 @subsection Creating the Archive
1118 @xopindex{create, introduced}
1119 To place the files @file{blues}, @file{folk}, and @file{jazz} into an
1120 archive named @file{collection.tar}, use the following command:
1123 $ @kbd{tar --create --file=collection.tar blues folk jazz}
1126 The order of the arguments is not very important, @emph{when using long
1127 option forms}. You could also say:
1130 $ @kbd{tar blues --create folk --file=collection.tar jazz}
1134 However, you can see that this order is harder to understand; this is
1135 why we will list the arguments in the order that makes the commands
1136 easiest to understand (and we encourage you to do the same when you use
1137 @command{tar}, to avoid errors).
1139 Note that the sequence
1140 @option{--file=@-collection.tar} is considered to be @emph{one} argument.
1141 If you substituted any other string of characters for
1142 @kbd{collection.tar}, then that string would become the name of the
1143 archive file you create.
1145 The order of the options becomes more important when you begin to use
1146 short forms. With short forms, if you type commands in the wrong order
1147 (even if you type them correctly in all other ways), you may end up with
1148 results you don't expect. For this reason, it is a good idea to get
1149 into the habit of typing options in the order that makes inherent sense.
1150 @xref{short create}, for more information on this.
1152 In this example, you type the command as shown above: @option{--create}
1153 is the operation which creates the new archive
1154 (@file{collection.tar}), and @option{--file} is the option which lets
1155 you give it the name you chose. The files, @file{blues}, @file{folk},
1156 and @file{jazz}, are now members of the archive, @file{collection.tar}
1157 (they are @dfn{file name arguments} to the @option{--create} operation.
1158 @xref{Choosing}, for the detailed discussion on these.) Now that they are
1159 in the archive, they are called @emph{archive members}, not files.
1160 (@pxref{Definitions,members}).
1162 When you create an archive, you @emph{must} specify which files you
1163 want placed in the archive. If you do not specify any archive
1164 members, @GNUTAR{} will complain.
1166 If you now list the contents of the working directory (@command{ls}), you will
1167 find the archive file listed as well as the files you saw previously:
1170 blues folk jazz collection.tar
1174 Creating the archive @samp{collection.tar} did not destroy the copies of
1175 the files in the directory.
1177 Keep in mind that if you don't indicate an operation, @command{tar} will not
1178 run and will prompt you for one. If you don't name any files, @command{tar}
1179 will complain. You must have write access to the working directory,
1180 or else you will not be able to create an archive in that directory.
1182 @emph{Caution}: Do not attempt to use @option{--create} (@option{-c}) to add files to
1183 an existing archive; it will delete the archive and write a new one.
1184 Use @option{--append} (@option{-r}) instead. @xref{append}.
1186 @node create verbose
1187 @subsection Running @option{--create} with @option{--verbose}
1189 @xopindex{create, using with @option{--verbose}}
1190 @xopindex{verbose, using with @option{--create}}
1191 If you include the @option{--verbose} (@option{-v}) option on the command line,
1192 @command{tar} will list the files it is acting on as it is working. In
1193 verbose mode, the @code{create} example above would appear as:
1196 $ @kbd{tar --create --verbose --file=collection.tar blues folk jazz}
1202 This example is just like the example we showed which did not use
1203 @option{--verbose}, except that @command{tar} generated the remaining lines
1205 (note the different font styles).
1211 In the rest of the examples in this chapter, we will frequently use
1212 @code{verbose} mode so we can show actions or @command{tar} responses that
1213 you would otherwise not see, and which are important for you to
1217 @subsection Short Forms with @samp{create}
1219 As we said before, the @option{--create} (@option{-c}) operation is one of the most
1220 basic uses of @command{tar}, and you will use it countless times.
1221 Eventually, you will probably want to use abbreviated (or ``short'')
1222 forms of options. A full discussion of the three different forms that
1223 options can take appears in @ref{Styles}; for now, here is what the
1224 previous example (including the @option{--verbose} (@option{-v}) option) looks like
1225 using short option forms:
1228 $ @kbd{tar -cvf collection.tar blues folk jazz}
1235 As you can see, the system responds the same no matter whether you use
1236 long or short option forms.
1238 @FIXME{i don't like how this is worded:} One difference between using
1239 short and long option forms is that, although the exact placement of
1240 arguments following options is no more specific when using short forms,
1241 it is easier to become confused and make a mistake when using short
1242 forms. For example, suppose you attempted the above example in the
1246 $ @kbd{tar -cfv collection.tar blues folk jazz}
1250 In this case, @command{tar} will make an archive file called @file{v},
1251 containing the files @file{blues}, @file{folk}, and @file{jazz}, because
1252 the @samp{v} is the closest ``file name'' to the @option{-f} option, and
1253 is thus taken to be the chosen archive file name. @command{tar} will try
1254 to add a file called @file{collection.tar} to the @file{v} archive file;
1255 if the file @file{collection.tar} did not already exist, @command{tar} will
1256 report an error indicating that this file does not exist. If the file
1257 @file{collection.tar} does already exist (e.g., from a previous command
1258 you may have run), then @command{tar} will add this file to the archive.
1259 Because the @option{-v} option did not get registered, @command{tar} will not
1260 run under @samp{verbose} mode, and will not report its progress.
1262 The end result is that you may be quite confused about what happened,
1263 and possibly overwrite a file. To illustrate this further, we will show
1264 you how an example we showed previously would look using short forms.
1269 $ @kbd{tar blues --create folk --file=collection.tar jazz}
1273 is confusing as it is. When shown using short forms, however, it
1274 becomes much more so:
1277 $ @kbd{tar blues -c folk -f collection.tar jazz}
1281 It would be very easy to put the wrong string of characters
1282 immediately following the @option{-f}, but doing that could sacrifice
1285 For this reason, we recommend that you pay very careful attention to
1286 the order of options and placement of file and archive names,
1287 especially when using short option forms. Not having the option name
1288 written out mnemonically can affect how well you remember which option
1289 does what, and therefore where different names have to be placed.
1292 @subsection Archiving Directories
1294 @cindex Archiving Directories
1295 @cindex Directories, Archiving
1296 You can archive a directory by specifying its directory name as a
1297 file name argument to @command{tar}. The files in the directory will be
1298 archived relative to the working directory, and the directory will be
1299 re-created along with its contents when the archive is extracted.
1301 To archive a directory, first move to its superior directory. If you
1302 have followed the previous instructions in this tutorial, you should
1311 This will put you into the directory which contains @file{practice},
1312 i.e., your home directory. Once in the superior directory, you can
1313 specify the subdirectory, @file{practice}, as a file name argument. To
1314 store @file{practice} in the new archive file @file{music.tar}, type:
1317 $ @kbd{tar --create --verbose --file=music.tar practice}
1321 @command{tar} should output:
1328 practice/collection.tar
1331 Note that the archive thus created is not in the subdirectory
1332 @file{practice}, but rather in the current working directory---the
1333 directory from which @command{tar} was invoked. Before trying to archive a
1334 directory from its superior directory, you should make sure you have
1335 write access to the superior directory itself, not only the directory
1336 you are trying archive with @command{tar}. For example, you will probably
1337 not be able to store your home directory in an archive by invoking
1338 @command{tar} from the root directory; @xref{absolute}. (Note
1339 also that @file{collection.tar}, the original archive file, has itself
1340 been archived. @command{tar} will accept any file as a file to be
1341 archived, regardless of its content. When @file{music.tar} is
1342 extracted, the archive file @file{collection.tar} will be re-written
1343 into the file system).
1345 If you give @command{tar} a command such as
1348 $ @kbd{tar --create --file=foo.tar .}
1352 @command{tar} will report @samp{tar: ./foo.tar is the archive; not
1353 dumped}. This happens because @command{tar} creates the archive
1354 @file{foo.tar} in the current directory before putting any files into
1355 it. Then, when @command{tar} attempts to add all the files in the
1356 directory @file{.} to the archive, it notices that the file
1357 @file{./foo.tar} is the same as the archive @file{foo.tar}, and skips
1358 it. (It makes no sense to put an archive into itself.) @GNUTAR{}
1359 will continue in this case, and create the archive
1360 normally, except for the exclusion of that one file. (@emph{Please
1361 note:} Other implementations of @command{tar} may not be so clever;
1362 they will enter an infinite loop when this happens, so you should not
1363 depend on this behavior unless you are certain you are running
1364 @GNUTAR{}. In general, it is wise to always place the archive outside
1365 of the directory being dumped.
1368 @section How to List Archives
1371 Frequently, you will find yourself wanting to determine exactly what a
1372 particular archive contains. You can use the @option{--list}
1373 (@option{-t}) operation to get the member names as they currently
1374 appear in the archive, as well as various attributes of the files at
1375 the time they were archived. For example, you can examine the archive
1376 @file{collection.tar} that you created in the last section with the
1380 $ @kbd{tar --list --file=collection.tar}
1384 The output of @command{tar} would then be:
1393 The archive @file{bfiles.tar} would list as follows:
1402 Be sure to use a @option{--file=@var{archive-name}} (@option{-f
1403 @var{archive-name}}) option just as with @option{--create}
1404 (@option{-c}) to specify the name of the archive.
1406 @xopindex{list, using with @option{--verbose}}
1407 @xopindex{verbose, using with @option{--list}}
1408 If you use the @option{--verbose} (@option{-v}) option with
1409 @option{--list}, then @command{tar} will print out a listing
1410 reminiscent of @w{@samp{ls -l}}, showing owner, file size, and so
1411 forth. This output is described in detail in @ref{verbose member listing}.
1413 If you had used @option{--verbose} (@option{-v}) mode, the example
1414 above would look like:
1417 $ @kbd{tar --list --verbose --file=collection.tar folk}
1418 -rw-r--r-- myself user 62 1990-05-23 10:55 folk
1421 @cindex listing member and file names
1422 @anchor{listing member and file names}
1423 It is important to notice that the output of @kbd{tar --list
1424 --verbose} does not necessarily match that produced by @kbd{tar
1425 --create --verbose} while creating the archive. It is because
1426 @GNUTAR{}, unless told explicitly not to do so, removes some directory
1427 prefixes from file names before storing them in the archive
1428 (@xref{absolute}, for more information). In other
1429 words, in verbose mode @GNUTAR{} shows @dfn{file names} when creating
1430 an archive and @dfn{member names} when listing it. Consider this
1435 $ @kbd{tar --create --verbose --file archive /etc/mail}
1436 tar: Removing leading `/' from member names
1438 /etc/mail/sendmail.cf
1440 $ @kbd{tar --test --file archive}
1442 etc/mail/sendmail.cf
1447 @opindex show-stored-names
1448 This default behavior can sometimes be inconvenient. You can force
1449 @GNUTAR{} show member names when creating archive by supplying
1450 @option{--show-stored-names} option.
1453 @item --show-stored-names
1454 Print member (as opposed to @emph{file}) names when creating the archive.
1457 @cindex File name arguments, using @option{--list} with
1458 @xopindex{list, using with file name arguments}
1459 You can specify one or more individual member names as arguments when
1460 using @samp{list}. In this case, @command{tar} will only list the
1461 names of members you identify. For example, @w{@kbd{tar --list
1462 --file=afiles.tar apple}} would only print @file{apple}.
1464 Because @command{tar} preserves file names, these must be specified as
1465 they appear in the archive (i.e., relative to the directory from which
1466 the archive was created). Therefore, it is essential when specifying
1467 member names to @command{tar} that you give the exact member names.
1468 For example, @w{@kbd{tar --list --file=bfiles.tar birds}} would produce an
1469 error message something like @samp{tar: birds: Not found in archive},
1470 because there is no member named @file{birds}, only one named
1471 @file{./birds}. While the names @file{birds} and @file{./birds} name
1472 the same file, @emph{member} names by default are compared verbatim.
1474 However, @w{@kbd{tar --list --file=bfiles.tar baboon}} would respond
1475 with @file{baboon}, because this exact member name is in the archive file
1476 @file{bfiles.tar}. If you are not sure of the exact file name,
1477 use @dfn{globbing patterns}, for example:
1480 $ @kbd{tar --list --file=bfiles.tar --wildcards '*b*'}
1484 will list all members whose name contains @samp{b}. @xref{wildcards},
1485 for a detailed discussion of globbing patterns and related
1486 @command{tar} command line options.
1493 @unnumberedsubsec Listing the Contents of a Stored Directory
1495 To get information about the contents of an archived directory,
1496 use the directory name as a file name argument in conjunction with
1497 @option{--list} (@option{-t}). To find out file attributes, include the
1498 @option{--verbose} (@option{-v}) option.
1500 For example, to find out about files in the directory @file{practice}, in
1501 the archive file @file{music.tar}, type:
1504 $ @kbd{tar --list --verbose --file=music.tar practice}
1507 @command{tar} responds:
1510 drwxrwxrwx myself user 0 1990-05-31 21:49 practice/
1511 -rw-r--r-- myself user 42 1990-05-21 13:29 practice/blues
1512 -rw-r--r-- myself user 62 1990-05-23 10:55 practice/folk
1513 -rw-r--r-- myself user 40 1990-05-21 13:30 practice/jazz
1514 -rw-r--r-- myself user 10240 1990-05-31 21:49 practice/collection.tar
1517 When you use a directory name as a file name argument, @command{tar} acts on
1518 all the files (including sub-directories) in that directory.
1521 @section How to Extract Members from an Archive
1523 @cindex Retrieving files from an archive
1524 @cindex Resurrecting files from an archive
1527 Creating an archive is only half the job---there is no point in storing
1528 files in an archive if you can't retrieve them. The act of retrieving
1529 members from an archive so they can be used and manipulated as
1530 unarchived files again is called @dfn{extraction}. To extract files
1531 from an archive, use the @option{--extract} (@option{--get} or
1532 @option{-x}) operation. As with @option{--create}, specify the name
1533 of the archive with @option{--file} (@option{-f}) option. Extracting
1534 an archive does not modify the archive in any way; you can extract it
1535 multiple times if you want or need to.
1537 Using @option{--extract}, you can extract an entire archive, or specific
1538 files. The files can be directories containing other files, or not. As
1539 with @option{--create} (@option{-c}) and @option{--list} (@option{-t}), you may use the short or the
1540 long form of the operation without affecting the performance.
1543 * extracting archives::
1544 * extracting files::
1546 * extracting untrusted archives::
1547 * failing commands::
1550 @node extracting archives
1551 @subsection Extracting an Entire Archive
1553 To extract an entire archive, specify the archive file name only, with
1554 no individual file names as arguments. For example,
1557 $ @kbd{tar -xvf collection.tar}
1564 -rw-r--r-- me user 28 1996-10-18 16:31 jazz
1565 -rw-r--r-- me user 21 1996-09-23 16:44 blues
1566 -rw-r--r-- me user 20 1996-09-23 16:44 folk
1569 @node extracting files
1570 @subsection Extracting Specific Files
1572 To extract specific archive members, give their exact member names as
1573 arguments, as printed by @option{--list} (@option{-t}). If you had
1574 mistakenly deleted one of the files you had placed in the archive
1575 @file{collection.tar} earlier (say, @file{blues}), you can extract it
1576 from the archive without changing the archive's structure. Its
1577 contents will be identical to the original file @file{blues} that you
1580 First, make sure you are in the @file{practice} directory, and list the
1581 files in the directory. Now, delete the file, @samp{blues}, and list
1582 the files in the directory again.
1584 You can now extract the member @file{blues} from the archive file
1585 @file{collection.tar} like this:
1588 $ @kbd{tar --extract --file=collection.tar blues}
1592 If you list the files in the directory again, you will see that the file
1593 @file{blues} has been restored, with its original permissions, data
1594 modification times, and owner.@footnote{This is only accidentally
1595 true, but not in general. Whereas modification times are always
1596 restored, in most cases, one has to be root for restoring the owner,
1597 and use a special option for restoring permissions. Here, it just
1598 happens that the restoring user is also the owner of the archived
1599 members, and that the current @code{umask} is compatible with original
1600 permissions.} (These parameters will be identical to those which
1601 the file had when you originally placed it in the archive; any changes
1602 you may have made before deleting the file from the file system,
1603 however, will @emph{not} have been made to the archive member.) The
1604 archive file, @samp{collection.tar}, is the same as it was before you
1605 extracted @samp{blues}. You can confirm this by running @command{tar} with
1606 @option{--list} (@option{-t}).
1608 Remember that as with other operations, specifying the exact member
1609 name is important. @w{@kbd{tar --extract --file=bfiles.tar birds}}
1610 will fail, because there is no member named @file{birds}. To extract
1611 the member named @file{./birds}, you must specify @w{@kbd{tar
1612 --extract --file=bfiles.tar ./birds}}. If you don't remember the
1613 exact member names, use @option{--list} (@option{-t}) option
1614 (@pxref{list}). You can also extract those members that match a
1615 specific @dfn{globbing pattern}. For example, to extract from
1616 @file{bfiles.tar} all files that begin with @samp{b}, no matter their
1617 directory prefix, you could type:
1620 $ @kbd{tar -x -f bfiles.tar --wildcards --no-anchored 'b*'}
1624 Here, @option{--wildcards} instructs @command{tar} to treat
1625 command line arguments as globbing patterns and @option{--no-anchored}
1626 informs it that the patterns apply to member names after any @samp{/}
1627 delimiter. The use of globbing patterns is discussed in detail in
1630 You can extract a file to standard output by combining the above options
1631 with the @option{--to-stdout} (@option{-O}) option (@pxref{Writing to Standard
1634 If you give the @option{--verbose} option, then @option{--extract}
1635 will print the names of the archive members as it extracts them.
1638 @subsection Extracting Files that are Directories
1640 Extracting directories which are members of an archive is similar to
1641 extracting other files. The main difference to be aware of is that if
1642 the extracted directory has the same name as any directory already in
1643 the working directory, then files in the extracted directory will be
1644 placed into the directory of the same name. Likewise, if there are
1645 files in the pre-existing directory with the same names as the members
1646 which you extract, the files from the extracted archive will replace
1647 the files already in the working directory (and possible
1648 subdirectories). This will happen regardless of whether or not the
1649 files in the working directory were more recent than those extracted
1650 (there exist, however, special options that alter this behavior
1653 However, if a file was stored with a directory name as part of its file
1654 name, and that directory does not exist under the working directory when
1655 the file is extracted, @command{tar} will create the directory.
1657 We can demonstrate how to use @option{--extract} to extract a directory
1658 file with an example. Change to the @file{practice} directory if you
1659 weren't there, and remove the files @file{folk} and @file{jazz}. Then,
1660 go back to the parent directory and extract the archive
1661 @file{music.tar}. You may either extract the entire archive, or you may
1662 extract only the files you just deleted. To extract the entire archive,
1663 don't give any file names as arguments after the archive name
1664 @file{music.tar}. To extract only the files you deleted, use the
1668 $ @kbd{tar -xvf music.tar practice/folk practice/jazz}
1674 If you were to specify two @option{--verbose} (@option{-v}) options, @command{tar}
1675 would have displayed more detail about the extracted files, as shown
1676 in the example below:
1679 $ @kbd{tar -xvvf music.tar practice/folk practice/jazz}
1680 -rw-r--r-- me user 28 1996-10-18 16:31 practice/jazz
1681 -rw-r--r-- me user 20 1996-09-23 16:44 practice/folk
1685 Because you created the directory with @file{practice} as part of the
1686 file names of each of the files by archiving the @file{practice}
1687 directory as @file{practice}, you must give @file{practice} as part
1688 of the file names when you extract those files from the archive.
1690 @node extracting untrusted archives
1691 @subsection Extracting Archives from Untrusted Sources
1693 Extracting files from archives can overwrite files that already exist.
1694 If you receive an archive from an untrusted source, you should make a
1695 new directory and extract into that directory, so that you don't have
1696 to worry about the extraction overwriting one of your existing files.
1697 For example, if @file{untrusted.tar} came from somewhere else on the
1698 Internet, and you don't necessarily trust its contents, you can
1699 extract it as follows:
1702 $ @kbd{mkdir newdir}
1704 $ @kbd{tar -xvf ../untrusted.tar}
1707 It is also a good practice to examine contents of the archive
1708 before extracting it, using @option{--list} (@option{-t}) option, possibly combined
1709 with @option{--verbose} (@option{-v}).
1711 @node failing commands
1712 @subsection Commands That Will Fail
1714 Here are some sample commands you might try which will not work, and why
1717 If you try to use this command,
1720 $ @kbd{tar -xvf music.tar folk jazz}
1724 you will get the following response:
1727 tar: folk: Not found in archive
1728 tar: jazz: Not found in archive
1733 This is because these files were not originally @emph{in} the parent
1734 directory @file{..}, where the archive is located; they were in the
1735 @file{practice} directory, and their file names reflect this:
1738 $ @kbd{tar -tvf music.tar}
1744 @FIXME{make sure the above works when going through the examples in
1748 Likewise, if you try to use this command,
1751 $ @kbd{tar -tvf music.tar folk jazz}
1755 you would get a similar response. Members with those names are not in the
1756 archive. You must use the correct member names, or wildcards, in order
1757 to extract the files from the archive.
1759 If you have forgotten the correct names of the files in the archive,
1760 use @w{@kbd{tar --list --verbose}} to list them correctly.
1762 @FIXME{more examples, here? hag thinks it's a good idea.}
1765 @section Going Further Ahead in this Manual
1768 @FIXME{need to write up a node here about the things that are going to
1769 be in the rest of the manual.}
1771 @node tar invocation
1772 @chapter Invoking @GNUTAR{}
1774 This chapter is about how one invokes the @GNUTAR{}
1775 command, from the command synopsis (@pxref{Synopsis}). There are
1776 numerous options, and many styles for writing them. One mandatory
1777 option specifies the operation @command{tar} should perform
1778 (@pxref{Operation Summary}), other options are meant to detail how
1779 this operation should be performed (@pxref{Option Summary}).
1780 Non-option arguments are not always interpreted the same way,
1781 depending on what the operation is.
1783 You will find in this chapter everything about option styles and rules for
1784 writing them (@pxref{Styles}). On the other hand, operations and options
1785 are fully described elsewhere, in other chapters. Here, you will find
1786 only synthetic descriptions for operations and options, together with
1787 pointers to other parts of the @command{tar} manual.
1789 Some options are so special they are fully described right in this
1790 chapter. They have the effect of inhibiting the normal operation of
1791 @command{tar} or else, they globally alter the amount of feedback the user
1792 receives about what is going on. These are the @option{--help} and
1793 @option{--version} (@pxref{help}), @option{--verbose} (@pxref{verbose})
1794 and @option{--interactive} options (@pxref{interactive}).
1798 * using tar options::
1810 @section General Synopsis of @command{tar}
1812 The @GNUTAR{} program is invoked as either one of:
1815 @kbd{tar @var{option}@dots{} [@var{name}]@dots{}}
1816 @kbd{tar @var{letter}@dots{} [@var{argument}]@dots{} [@var{option}]@dots{} [@var{name}]@dots{}}
1819 The second form is for when old options are being used.
1821 You can use @command{tar} to store files in an archive, to extract them from
1822 an archive, and to do other types of archive manipulation. The primary
1823 argument to @command{tar}, which is called the @dfn{operation}, specifies
1824 which action to take. The other arguments to @command{tar} are either
1825 @dfn{options}, which change the way @command{tar} performs an operation,
1826 or file names or archive members, which specify the files or members
1827 @command{tar} is to act on.
1829 You can actually type in arguments in any order, even if in this manual
1830 the options always precede the other arguments, to make examples easier
1831 to understand. Further, the option stating the main operation mode
1832 (the @command{tar} main command) is usually given first.
1834 Each @var{name} in the synopsis above is interpreted as an archive member
1835 name when the main command is one of @option{--compare}
1836 (@option{--diff}, @option{-d}), @option{--delete}, @option{--extract}
1837 (@option{--get}, @option{-x}), @option{--list} (@option{-t}) or
1838 @option{--update} (@option{-u}). When naming archive members, you
1839 must give the exact name of the member in the archive, as it is
1840 printed by @option{--list}. For @option{--append} (@option{-r}) and
1841 @option{--create} (@option{-c}), these @var{name} arguments specify
1842 the names of either files or directory hierarchies to place in the archive.
1843 These files or hierarchies should already exist in the file system,
1844 prior to the execution of the @command{tar} command.
1846 @command{tar} interprets relative file names as being relative to the
1847 working directory. @command{tar} will make all file names relative
1848 (by removing leading slashes when archiving or restoring files),
1849 unless you specify otherwise (using the @option{--absolute-names}
1850 option). @xref{absolute}, for more information about
1851 @option{--absolute-names}.
1853 If you give the name of a directory as either a file name or a member
1854 name, then @command{tar} acts recursively on all the files and directories
1855 beneath that directory. For example, the name @file{/} identifies all
1856 the files in the file system to @command{tar}.
1858 The distinction between file names and archive member names is especially
1859 important when shell globbing is used, and sometimes a source of confusion
1860 for newcomers. @xref{wildcards}, for more information about globbing.
1861 The problem is that shells may only glob using existing files in the
1862 file system. Only @command{tar} itself may glob on archive members, so when
1863 needed, you must ensure that wildcard characters reach @command{tar} without
1864 being interpreted by the shell first. Using a backslash before @samp{*}
1865 or @samp{?}, or putting the whole argument between quotes, is usually
1866 sufficient for this.
1868 Even if @var{name}s are often specified on the command line, they
1869 can also be read from a text file in the file system, using the
1870 @option{--files-from=@var{file-of-names}} (@option{-T @var{file-of-names}}) option.
1872 If you don't use any file name arguments, @option{--append} (@option{-r}),
1873 @option{--delete} and @option{--concatenate} (@option{--catenate},
1874 @option{-A}) will do nothing, while @option{--create} (@option{-c})
1875 will usually yield a diagnostic and inhibit @command{tar} execution.
1876 The other operations of @command{tar} (@option{--list},
1877 @option{--extract}, @option{--compare}, and @option{--update})
1878 will act on the entire contents of the archive.
1881 @cindex return status
1882 Besides successful exits, @GNUTAR{} may fail for
1883 many reasons. Some reasons correspond to bad usage, that is, when the
1884 @command{tar} command line is improperly written. Errors may be
1885 encountered later, while processing the archive or the files. Some
1886 errors are recoverable, in which case the failure is delayed until
1887 @command{tar} has completed all its work. Some errors are such that
1888 it would be not meaningful, or at least risky, to continue processing:
1889 @command{tar} then aborts processing immediately. All abnormal exits,
1890 whether immediate or delayed, should always be clearly diagnosed on
1891 @code{stderr}, after a line stating the nature of the error.
1893 Possible exit codes of @GNUTAR{} are summarized in the following
1898 @samp{Successful termination}.
1901 @samp{Some files differ}. If tar was invoked with @option{--compare}
1902 (@option{--diff}, @option{-d}) command line option, this means that
1903 some files in the archive differ from their disk counterparts
1904 (@pxref{compare}). If tar was given @option{--create},
1905 @option{--append} or @option{--update} option, this exit code means
1906 that some files were changed while being archived and so the resulting
1907 archive does not contain the exact copy of the file set.
1910 @samp{Fatal error}. This means that some fatal, unrecoverable error
1914 If @command{tar} has invoked a subprocess and that subprocess exited with a
1915 nonzero exit code, @command{tar} exits with that code as well.
1916 This can happen, for example, if @command{tar} was given some
1917 compression option (@pxref{gzip}) and the external compressor program
1918 failed. Another example is @command{rmt} failure during backup to the
1919 remote device (@pxref{Remote Tape Server}).
1921 @node using tar options
1922 @section Using @command{tar} Options
1924 @GNUTAR{} has a total of eight operating modes which
1925 allow you to perform a variety of tasks. You are required to choose
1926 one operating mode each time you employ the @command{tar} program by
1927 specifying one, and only one operation as an argument to the
1928 @command{tar} command (the corresponding options may be found
1929 at @ref{frequent operations} and @ref{Operations}). Depending on
1930 circumstances, you may also wish to customize how the chosen operating
1931 mode behaves. For example, you may wish to change the way the output
1932 looks, or the format of the files that you wish to archive may require
1933 you to do something special in order to make the archive look right.
1935 You can customize and control @command{tar}'s performance by running
1936 @command{tar} with one or more options (such as @option{--verbose}
1937 (@option{-v}), which we used in the tutorial). As we said in the
1938 tutorial, @dfn{options} are arguments to @command{tar} which are (as
1939 their name suggests) optional. Depending on the operating mode, you
1940 may specify one or more options. Different options will have different
1941 effects, but in general they all change details of the operation, such
1942 as archive format, archive name, or level of user interaction. Some
1943 options make sense with all operating modes, while others are
1944 meaningful only with particular modes. You will likely use some
1945 options frequently, while you will only use others infrequently, or
1946 not at all. (A full list of options is available in @pxref{All Options}.)
1948 @vrindex TAR_OPTIONS, environment variable
1949 @anchor{TAR_OPTIONS}
1950 The @env{TAR_OPTIONS} environment variable specifies default options to
1951 be placed in front of any explicit options. For example, if
1952 @code{TAR_OPTIONS} is @samp{-v --unlink-first}, @command{tar} behaves as
1953 if the two options @option{-v} and @option{--unlink-first} had been
1954 specified before any explicit options. Option specifications are
1955 separated by whitespace. A backslash escapes the next character, so it
1956 can be used to specify an option containing whitespace or a backslash.
1958 Note that @command{tar} options are case sensitive. For example, the
1959 options @option{-T} and @option{-t} are different; the first requires an
1960 argument for stating the name of a file providing a list of @var{name}s,
1961 while the second does not require an argument and is another way to
1962 write @option{--list} (@option{-t}).
1964 In addition to the eight operations, there are many options to
1965 @command{tar}, and three different styles for writing both: long (mnemonic)
1966 form, short form, and old style. These styles are discussed below.
1967 Both the options and the operations can be written in any of these three
1970 @FIXME{menu at end of this node. need to think of an actual outline
1971 for this chapter; probably do that after stuff from chapter 4 is
1975 @section The Three Option Styles
1977 There are three styles for writing operations and options to the command
1978 line invoking @command{tar}. The different styles were developed at
1979 different times during the history of @command{tar}. These styles will be
1980 presented below, from the most recent to the oldest.
1982 Some options must take an argument. (For example, @option{--file}
1983 (@option{-f})) takes the name of an archive file as an argument. If
1984 you do not supply an archive file name, @command{tar} will use a
1985 default, but this can be confusing; thus, we recommend that you always
1986 supply a specific archive file name.) Where you @emph{place} the
1987 arguments generally depends on which style of options you choose. We
1988 will detail specific information relevant to each option style in the
1989 sections on the different option styles, below. The differences are
1990 subtle, yet can often be very important; incorrect option placement
1991 can cause you to overwrite a number of important files. We urge you
1992 to note these differences, and only use the option style(s) which
1993 makes the most sense to you until you feel comfortable with the others.
1995 Some options @emph{may} take an argument. Such options may have at
1996 most long and short forms, they do not have old style equivalent. The
1997 rules for specifying an argument for such options are stricter than
1998 those for specifying mandatory arguments. Please, pay special
2002 * Long Options:: Long Option Style
2003 * Short Options:: Short Option Style
2004 * Old Options:: Old Option Style
2005 * Mixing:: Mixing Option Styles
2009 @subsection Long Option Style
2011 @cindex long options
2012 @cindex options, long style
2013 @cindex options, GNU style
2014 @cindex options, mnemonic names
2015 Each option has at least one @dfn{long} (or @dfn{mnemonic}) name starting with two
2016 dashes in a row, e.g., @option{--list}. The long names are more clear than
2017 their corresponding short or old names. It sometimes happens that a
2018 single long option has many different names which are
2019 synonymous, such as @option{--compare} and @option{--diff}. In addition,
2020 long option names can be given unique abbreviations. For example,
2021 @option{--cre} can be used in place of @option{--create} because there is no
2022 other long option which begins with @samp{cre}. (One way to find
2023 this out is by trying it and seeing what happens; if a particular
2024 abbreviation could represent more than one option, @command{tar} will tell
2025 you that that abbreviation is ambiguous and you'll know that that
2026 abbreviation won't work. You may also choose to run @samp{tar --help}
2027 to see a list of options. Be aware that if you run @command{tar} with a
2028 unique abbreviation for the long name of an option you didn't want to
2029 use, you are stuck; @command{tar} will perform the command as ordered.)
2031 Long options are meant to be obvious and easy to remember, and their
2032 meanings are generally easier to discern than those of their
2033 corresponding short options (see below). For example:
2036 $ @kbd{tar --create --verbose --blocking-factor=20 --file=/dev/rmt0}
2040 gives a fairly good set of hints about what the command does, even
2041 for those not fully acquainted with @command{tar}.
2043 @cindex arguments to long options
2044 @cindex long options with mandatory arguments
2045 Long options which require arguments take those arguments
2046 immediately following the option name. There are two ways of
2047 specifying a mandatory argument. It can be separated from the
2048 option name either by an equal sign, or by any amount of
2049 white space characters. For example, the @option{--file} option (which
2050 tells the name of the @command{tar} archive) is given a file such as
2051 @file{archive.tar} as argument by using any of the following notations:
2052 @option{--file=archive.tar} or @option{--file archive.tar}.
2054 @cindex optional arguments to long options
2055 @cindex long options with optional arguments
2056 In contrast, optional arguments must always be introduced using
2057 an equal sign. For example, the @option{--backup} option takes
2058 an optional argument specifying backup type. It must be used
2059 as @option{--backup=@var{backup-type}}.
2062 @subsection Short Option Style
2064 @cindex short options
2065 @cindex options, short style
2066 @cindex options, traditional
2067 Most options also have a @dfn{short option} name. Short options start with
2068 a single dash, and are followed by a single character, e.g., @option{-t}
2069 (which is equivalent to @option{--list}). The forms are absolutely
2070 identical in function; they are interchangeable.
2072 The short option names are faster to type than long option names.
2074 @cindex arguments to short options
2075 @cindex short options with mandatory arguments
2076 Short options which require arguments take their arguments immediately
2077 following the option, usually separated by white space. It is also
2078 possible to stick the argument right after the short option name, using
2079 no intervening space. For example, you might write @w{@option{-f
2080 archive.tar}} or @option{-farchive.tar} instead of using
2081 @option{--file=archive.tar}. Both @option{--file=@var{archive-name}} and
2082 @w{@option{-f @var{archive-name}}} denote the option which indicates a
2083 specific archive, here named @file{archive.tar}.
2085 @cindex optional arguments to short options
2086 @cindex short options with optional arguments
2087 Short options which take optional arguments take their arguments
2088 immediately following the option letter, @emph{without any intervening
2089 white space characters}.
2091 Short options' letters may be clumped together, but you are not
2092 required to do this (as compared to old options; see below). When
2093 short options are clumped as a set, use one (single) dash for them
2094 all, e.g., @w{@samp{@command{tar} -cvf}}. Only the last option in
2095 such a set is allowed to have an argument@footnote{Clustering many
2096 options, the last of which has an argument, is a rather opaque way to
2097 write options. Some wonder if @acronym{GNU} @code{getopt} should not
2098 even be made helpful enough for considering such usages as invalid.}.
2100 When the options are separated, the argument for each option which requires
2101 an argument directly follows that option, as is usual for Unix programs.
2105 $ @kbd{tar -c -v -b 20 -f /dev/rmt0}
2108 If you reorder short options' locations, be sure to move any arguments
2109 that belong to them. If you do not move the arguments properly, you may
2110 end up overwriting files.
2113 @subsection Old Option Style
2114 @cindex options, old style
2115 @cindex old option style
2117 Like short options, @dfn{old options} are single letters. However, old options
2118 must be written together as a single clumped set, without spaces separating
2119 them or dashes preceding them@footnote{Beware that if you precede options
2120 with a dash, you are announcing the short option style instead of the
2121 old option style; short options are decoded differently.}. This set
2122 of letters must be the first to appear on the command line, after the
2123 @command{tar} program name and some white space; old options cannot appear
2124 anywhere else. The letter of an old option is exactly the same letter as
2125 the corresponding short option. For example, the old option @samp{t} is
2126 the same as the short option @option{-t}, and consequently, the same as the
2127 long option @option{--list}. So for example, the command @w{@samp{tar
2128 cv}} specifies the option @option{-v} in addition to the operation @option{-c}.
2130 @cindex arguments to old options
2131 @cindex old options with mandatory arguments
2132 When options that need arguments are given together with the command,
2133 all the associated arguments follow, in the same order as the options.
2134 Thus, the example given previously could also be written in the old
2138 $ @kbd{tar cvbf 20 /dev/rmt0}
2142 Here, @samp{20} is the argument of @option{-b} and @samp{/dev/rmt0} is
2143 the argument of @option{-f}.
2145 On the other hand, this old style syntax makes it difficult to match
2146 option letters with their corresponding arguments, and is often
2147 confusing. In the command @w{@samp{tar cvbf 20 /dev/rmt0}}, for example,
2148 @samp{20} is the argument for @option{-b}, @samp{/dev/rmt0} is the
2149 argument for @option{-f}, and @option{-v} does not have a corresponding
2150 argument. Even using short options like in @w{@samp{tar -c -v -b 20 -f
2151 /dev/rmt0}} is clearer, putting all arguments next to the option they
2154 If you want to reorder the letters in the old option argument, be
2155 sure to reorder any corresponding argument appropriately.
2157 This old way of writing @command{tar} options can surprise even experienced
2158 users. For example, the two commands:
2161 @kbd{tar cfz archive.tar.gz file}
2162 @kbd{tar -cfz archive.tar.gz file}
2166 are quite different. The first example uses @file{archive.tar.gz} as
2167 the value for option @samp{f} and recognizes the option @samp{z}. The
2168 second example, however, uses @file{z} as the value for option
2169 @samp{f} --- probably not what was intended.
2171 Old options are kept for compatibility with old versions of @command{tar}.
2173 This second example could be corrected in many ways, among which the
2174 following are equivalent:
2177 @kbd{tar -czf archive.tar.gz file}
2178 @kbd{tar -cf archive.tar.gz -z file}
2179 @kbd{tar cf archive.tar.gz -z file}
2182 @cindex option syntax, traditional
2183 As far as we know, all @command{tar} programs, @acronym{GNU} and
2184 non-@acronym{GNU}, support old options. @GNUTAR{}
2185 supports them not only for historical reasons, but also because many
2186 people are used to them. For compatibility with Unix @command{tar},
2187 the first argument is always treated as containing command and option
2188 letters even if it doesn't start with @samp{-}. Thus, @samp{tar c} is
2189 equivalent to @w{@samp{tar -c}:} both of them specify the
2190 @option{--create} (@option{-c}) command to create an archive.
2193 @subsection Mixing Option Styles
2195 @cindex options, mixing different styles
2196 All three styles may be intermixed in a single @command{tar} command,
2197 so long as the rules for each style are fully
2198 respected@footnote{Before @GNUTAR{} version 1.11.6,
2199 a bug prevented intermixing old style options with long options in
2200 some cases.}. Old style options and either of the modern styles of
2201 options may be mixed within a single @command{tar} command. However,
2202 old style options must be introduced as the first arguments only,
2203 following the rule for old options (old options must appear directly
2204 after the @command{tar} command and some white space). Modern options
2205 may be given only after all arguments to the old options have been
2206 collected. If this rule is not respected, a modern option might be
2207 falsely interpreted as the value of the argument to one of the old
2210 For example, all the following commands are wholly equivalent, and
2211 illustrate the many combinations and orderings of option styles.
2214 @kbd{tar --create --file=archive.tar}
2215 @kbd{tar --create -f archive.tar}
2216 @kbd{tar --create -farchive.tar}
2217 @kbd{tar --file=archive.tar --create}
2218 @kbd{tar --file=archive.tar -c}
2219 @kbd{tar -c --file=archive.tar}
2220 @kbd{tar -c -f archive.tar}
2221 @kbd{tar -c -farchive.tar}
2222 @kbd{tar -cf archive.tar}
2223 @kbd{tar -cfarchive.tar}
2224 @kbd{tar -f archive.tar --create}
2225 @kbd{tar -f archive.tar -c}
2226 @kbd{tar -farchive.tar --create}
2227 @kbd{tar -farchive.tar -c}
2228 @kbd{tar c --file=archive.tar}
2229 @kbd{tar c -f archive.tar}
2230 @kbd{tar c -farchive.tar}
2231 @kbd{tar cf archive.tar}
2232 @kbd{tar f archive.tar --create}
2233 @kbd{tar f archive.tar -c}
2234 @kbd{tar fc archive.tar}
2237 On the other hand, the following commands are @emph{not} equivalent to
2241 @kbd{tar -f -c archive.tar}
2242 @kbd{tar -fc archive.tar}
2243 @kbd{tar -fcarchive.tar}
2244 @kbd{tar -farchive.tarc}
2245 @kbd{tar cfarchive.tar}
2249 These last examples mean something completely different from what the
2250 user intended (judging based on the example in the previous set which
2251 uses long options, whose intent is therefore very clear). The first
2252 four specify that the @command{tar} archive would be a file named
2253 @option{-c}, @samp{c}, @samp{carchive.tar} or @samp{archive.tarc},
2254 respectively. The first two examples also specify a single non-option,
2255 @var{name} argument having the value @samp{archive.tar}. The last
2256 example contains only old style option letters (repeating option
2257 @samp{c} twice), not all of which are meaningful (eg., @samp{.},
2258 @samp{h}, or @samp{i}), with no argument value. @FIXME{not sure i liked
2259 the first sentence of this paragraph..}
2262 @section All @command{tar} Options
2264 The coming manual sections contain an alphabetical listing of all
2265 @command{tar} operations and options, with brief descriptions and cross
2266 references to more in-depth explanations in the body of the manual.
2267 They also contain an alphabetically arranged table of the short option
2268 forms with their corresponding long option. You can use this table as
2269 a reference for deciphering @command{tar} commands in scripts.
2272 * Operation Summary::
2274 * Short Option Summary::
2277 @node Operation Summary
2278 @subsection Operations
2286 Appends files to the end of the archive. @xref{append}.
2288 @opsummary{catenate}
2292 Same as @option{--concatenate}. @xref{concatenate}.
2298 Compares archive members with their counterparts in the file
2299 system, and reports differences in file size, mode, owner,
2300 modification date and contents. @xref{compare}.
2302 @opsummary{concatenate}
2306 Appends other @command{tar} archives to the end of the archive.
2313 Creates a new @command{tar} archive. @xref{create}.
2318 Deletes members from the archive. Don't try this on a archive on a
2319 tape! @xref{delete}.
2325 Same @option{--compare}. @xref{compare}.
2331 Extracts members from the archive into the file system. @xref{extract}.
2337 Same as @option{--extract}. @xref{extract}.
2343 Lists the members in an archive. @xref{list}.
2349 Adds files to the end of the archive, but only if they are newer than
2350 their counterparts already in the archive, or if they do not already
2351 exist in the archive. @xref{update}.
2355 @node Option Summary
2356 @subsection @command{tar} Options
2360 @opsummary{absolute-names}
2361 @item --absolute-names
2364 Normally when creating an archive, @command{tar} strips an initial
2365 @samp{/} from member names. This option disables that behavior.
2368 @opsummary{after-date}
2371 (See @option{--newer}, @pxref{after})
2373 @opsummary{anchored}
2375 A pattern must match an initial subsequence of the name's components.
2376 @xref{controlling pattern-matching}.
2378 @opsummary{atime-preserve}
2379 @item --atime-preserve
2380 @itemx --atime-preserve=replace
2381 @itemx --atime-preserve=system
2383 Attempt to preserve the access time of files when reading them. This
2384 option currently is effective only on files that you own, unless you
2385 have superuser privileges.
2387 @option{--atime-preserve=replace} remembers the access time of a file
2388 before reading it, and then restores the access time afterwards. This
2389 may cause problems if other programs are reading the file at the same
2390 time, as the times of their accesses will be lost. On most platforms
2391 restoring the access time also requires @command{tar} to restore the
2392 data modification time too, so this option may also cause problems if
2393 other programs are writing the file at the same time. (Tar attempts
2394 to detect this situation, but cannot do so reliably due to race
2395 conditions.) Worse, on most platforms restoring the access time also
2396 updates the status change time, which means that this option is
2397 incompatible with incremental backups.
2399 @option{--atime-preserve=system} avoids changing time stamps on files,
2400 without interfering with time stamp updates
2401 caused by other programs, so it works better with incremental backups.
2402 However, it requires a special @code{O_NOATIME} option from the
2403 underlying operating and file system implementation, and it also requires
2404 that searching directories does not update their access times. As of
2405 this writing (November 2005) this works only with Linux, and only with
2406 Linux kernels 2.6.8 and later. Worse, there is currently no reliable
2407 way to know whether this feature actually works. Sometimes
2408 @command{tar} knows that it does not work, and if you use
2409 @option{--atime-preserve=system} then @command{tar} complains and
2410 exits right away. But other times @command{tar} might think that the
2411 option works when it actually does not.
2413 Currently @option{--atime-preserve} with no operand defaults to
2414 @option{--atime-preserve=replace}, but this may change in the future
2415 as support for @option{--atime-preserve=system} improves.
2417 If your operating system does not support
2418 @option{--atime-preserve=@-system}, you might be able to preserve access
2419 times reliably by by using the @command{mount} command. For example,
2420 you can mount the file system read-only, or access the file system via
2421 a read-only loopback mount, or use the @samp{noatime} mount option
2422 available on some systems. However, mounting typically requires
2423 superuser privileges and can be a pain to manage.
2425 @opsummary{auto-compress}
2426 @item --auto-compress
2429 During a @option{--create} operation, enables automatic compressed
2430 format recognition based on the archive suffix. The effect of this
2431 option is cancelled by @option{--no-auto-compress}. @xref{gzip}.
2434 @item --backup=@var{backup-type}
2436 Rather than deleting files from the file system, @command{tar} will
2437 back them up using simple or numbered backups, depending upon
2438 @var{backup-type}. @xref{backup}.
2440 @opsummary{block-number}
2441 @item --block-number
2444 With this option present, @command{tar} prints error messages for read errors
2445 with the block number in the archive file. @xref{block-number}.
2447 @opsummary{blocking-factor}
2448 @item --blocking-factor=@var{blocking}
2449 @itemx -b @var{blocking}
2451 Sets the blocking factor @command{tar} uses to @var{blocking} x 512 bytes per
2452 record. @xref{Blocking Factor}.
2458 This option tells @command{tar} to read or write archives through
2459 @code{bzip2}. @xref{gzip}.
2461 @opsummary{check-device}
2462 @item --check-device
2463 Check device numbers when creating a list of modified files for
2464 incremental archiving. This is the default. @xref{device numbers},
2465 for a detailed description.
2467 @opsummary{checkpoint}
2468 @item --checkpoint[=@var{number}]
2470 This option directs @command{tar} to print periodic checkpoint
2471 messages as it reads through the archive. It is intended for when you
2472 want a visual indication that @command{tar} is still running, but
2473 don't want to see @option{--verbose} output. You can also instruct
2474 @command{tar} to execute a list of actions on each checkpoint, see
2475 @option{--checkpoint-action} below. For a detailed description, see
2478 @opsummary{checkpoint-action}
2479 @item --checkpoint-action=@var{action}
2480 Instruct @command{tar} to execute an action upon hitting a
2481 breakpoint. Here we give only a brief outline. @xref{checkpoints},
2482 for a complete description.
2484 The @var{action} argument can be one of the following:
2488 Produce an audible bell on the console.
2492 Print a single dot on the standard listing stream.
2495 Display a textual message on the standard error, with the status and
2496 number of the checkpoint. This is the default.
2498 @item echo=@var{string}
2499 Display @var{string} on the standard error. Before output, the string
2500 is subject to meta-character expansion.
2502 @item exec=@var{command}
2503 Execute the given @var{command}.
2505 @item sleep=@var{time}
2506 Wait for @var{time} seconds.
2508 @item ttyout=@var{string}
2509 Output @var{string} on the current console (@file{/dev/tty}).
2512 Several @option{--checkpoint-action} options can be specified. The
2513 supplied actions will be executed in order of their appearance in the
2516 Using @option{--checkpoint-action} without @option{--checkpoint}
2517 assumes default checkpoint frequency of one checkpoint per 10 records.
2519 @opsummary{check-links}
2522 If this option was given, @command{tar} will check the number of links
2523 dumped for each processed file. If this number does not match the
2524 total number of hard links for the file, a warning message will be
2525 output @footnote{Earlier versions of @GNUTAR{} understood @option{-l} as a
2526 synonym for @option{--one-file-system}. The current semantics, which
2527 complies to UNIX98, was introduced with version
2528 1.15.91. @xref{Changes}, for more information.}.
2532 @opsummary{compress}
2533 @opsummary{uncompress}
2538 @command{tar} will use the @command{compress} program when reading or
2539 writing the archive. This allows you to directly act on archives
2540 while saving space. @xref{gzip}.
2542 @opsummary{confirmation}
2543 @item --confirmation
2545 (See @option{--interactive}.) @xref{interactive}.
2547 @opsummary{delay-directory-restore}
2548 @item --delay-directory-restore
2550 Delay setting modification times and permissions of extracted
2551 directories until the end of extraction. @xref{Directory Modification Times and Permissions}.
2553 @opsummary{dereference}
2557 When creating a @command{tar} archive, @command{tar} will archive the
2558 file that a symbolic link points to, rather than archiving the
2559 symlink. @xref{dereference}.
2561 @opsummary{directory}
2562 @item --directory=@var{dir}
2565 When this option is specified, @command{tar} will change its current directory
2566 to @var{dir} before performing any operations. When this option is used
2567 during archive creation, it is order sensitive. @xref{directory}.
2570 @item --exclude=@var{pattern}
2572 When performing operations, @command{tar} will skip files that match
2573 @var{pattern}. @xref{exclude}.
2575 @opsummary{exclude-from}
2576 @item --exclude-from=@var{file}
2577 @itemx -X @var{file}
2579 Similar to @option{--exclude}, except @command{tar} will use the list of
2580 patterns in the file @var{file}. @xref{exclude}.
2582 @opsummary{exclude-caches}
2583 @item --exclude-caches
2585 Exclude from dump any directory containing a valid cache directory
2586 tag file, but still dump the directory node and the tag file itself.
2590 @opsummary{exclude-caches-under}
2591 @item --exclude-caches-under
2593 Exclude from dump any directory containing a valid cache directory
2594 tag file, but still dump the directory node itself.
2598 @opsummary{exclude-caches-all}
2599 @item --exclude-caches-all
2601 Exclude from dump any directory containing a valid cache directory
2602 tag file. @xref{exclude}.
2604 @opsummary{exclude-tag}
2605 @item --exclude-tag=@var{file}
2607 Exclude from dump any directory containing file named @var{file}, but
2608 dump the directory node and @var{file} itself. @xref{exclude}.
2610 @opsummary{exclude-tag-under}
2611 @item --exclude-tag-under=@var{file}
2613 Exclude from dump the contents of any directory containing file
2614 named @var{file}, but dump the directory node itself. @xref{exclude}.
2616 @opsummary{exclude-tag-all}
2617 @item --exclude-tag-all=@var{file}
2619 Exclude from dump any directory containing file named @var{file}.
2622 @opsummary{exclude-vcs}
2625 Exclude from dump directories and files, that are internal for some
2626 widely used version control systems.
2631 @item --file=@var{archive}
2632 @itemx -f @var{archive}
2634 @command{tar} will use the file @var{archive} as the @command{tar} archive it
2635 performs operations on, rather than @command{tar}'s compilation dependent
2636 default. @xref{file tutorial}.
2638 @opsummary{files-from}
2639 @item --files-from=@var{file}
2640 @itemx -T @var{file}
2642 @command{tar} will use the contents of @var{file} as a list of archive members
2643 or files to operate on, in addition to those specified on the
2644 command-line. @xref{files}.
2646 @opsummary{force-local}
2649 Forces @command{tar} to interpret the file name given to @option{--file}
2650 as a local file, even if it looks like a remote tape drive name.
2651 @xref{local and remote archives}.
2654 @item --format=@var{format}
2655 @itemx -H @var{format}
2657 Selects output archive format. @var{Format} may be one of the
2662 Creates an archive that is compatible with Unix V7 @command{tar}.
2665 Creates an archive that is compatible with GNU @command{tar} version
2669 Creates archive in GNU tar 1.13 format. Basically it is the same as
2670 @samp{oldgnu} with the only difference in the way it handles long
2674 Creates a @acronym{POSIX.1-1988} compatible archive.
2677 Creates a @acronym{POSIX.1-2001 archive}.
2681 @xref{Formats}, for a detailed discussion of these formats.
2684 @item --group=@var{group}
2686 Files added to the @command{tar} archive will have a group @acronym{ID} of @var{group},
2687 rather than the group from the source file. @var{group} is first decoded
2688 as a group symbolic name, but if this interpretation fails, it has to be
2689 a decimal numeric group @acronym{ID}. @xref{override}.
2691 Also see the comments for the @option{--owner=@var{user}} option.
2701 This option tells @command{tar} to read or write archives through
2702 @command{gzip}, allowing @command{tar} to directly operate on several
2703 kinds of compressed archives transparently. @xref{gzip}.
2705 @opsummary{hard-dereference}
2706 @item --hard-dereference
2707 When creating an archive, dereference hard links and store the files
2708 they refer to, instead of creating usual hard link members.
2716 @command{tar} will print out a short message summarizing the operations and
2717 options to @command{tar} and exit. @xref{help}.
2719 @opsummary{ignore-case}
2721 Ignore case when matching member or file names with
2722 patterns. @xref{controlling pattern-matching}.
2724 @opsummary{ignore-command-error}
2725 @item --ignore-command-error
2726 Ignore exit codes of subprocesses. @xref{Writing to an External Program}.
2728 @opsummary{ignore-failed-read}
2729 @item --ignore-failed-read
2731 Do not exit unsuccessfully merely because an unreadable file was encountered.
2734 @opsummary{ignore-zeros}
2735 @item --ignore-zeros
2738 With this option, @command{tar} will ignore zeroed blocks in the
2739 archive, which normally signals EOF. @xref{Reading}.
2741 @opsummary{incremental}
2745 Informs @command{tar} that it is working with an old
2746 @acronym{GNU}-format incremental backup archive. It is intended
2747 primarily for backwards compatibility only. @xref{Incremental Dumps},
2748 for a detailed discussion of incremental archives.
2750 @opsummary{index-file}
2751 @item --index-file=@var{file}
2753 Send verbose output to @var{file} instead of to standard output.
2755 @opsummary{info-script}
2756 @opsummary{new-volume-script}
2757 @item --info-script=@var{script-file}
2758 @itemx --new-volume-script=@var{script-file}
2759 @itemx -F @var{script-file}
2761 When @command{tar} is performing multi-tape backups, @var{script-file} is run
2762 at the end of each tape. If @var{script-file} exits with nonzero status,
2763 @command{tar} fails immediately. @xref{info-script}, for a detailed
2764 discussion of @var{script-file}.
2766 @opsummary{interactive}
2768 @itemx --confirmation
2771 Specifies that @command{tar} should ask the user for confirmation before
2772 performing potentially destructive options, such as overwriting files.
2775 @opsummary{keep-newer-files}
2776 @item --keep-newer-files
2778 Do not replace existing files that are newer than their archive copies
2779 when extracting files from an archive.
2781 @opsummary{keep-old-files}
2782 @item --keep-old-files
2785 Do not overwrite existing files when extracting files from an archive.
2786 @xref{Keep Old Files}.
2789 @item --label=@var{name}
2790 @itemx -V @var{name}
2792 When creating an archive, instructs @command{tar} to write @var{name}
2793 as a name record in the archive. When extracting or listing archives,
2794 @command{tar} will only operate on archives that have a label matching
2795 the pattern specified in @var{name}. @xref{Tape Files}.
2798 @item --level=@var{n}
2799 Force incremental backup of level @var{n}. As of @GNUTAR version
2800 @value{VERSION}, the option @option{--level=0} truncates the snapshot
2801 file, thereby forcing the level 0 dump. Other values of @var{n} are
2802 effectively ignored. @xref{--level=0}, for details and examples.
2804 The use of this option is valid only in conjunction with the
2805 @option{--listed-incremental} option. @xref{Incremental Dumps},
2806 for a detailed description.
2808 @opsummary{listed-incremental}
2809 @item --listed-incremental=@var{snapshot-file}
2810 @itemx -g @var{snapshot-file}
2812 During a @option{--create} operation, specifies that the archive that
2813 @command{tar} creates is a new @acronym{GNU}-format incremental
2814 backup, using @var{snapshot-file} to determine which files to backup.
2815 With other operations, informs @command{tar} that the archive is in
2816 incremental format. @xref{Incremental Dumps}.
2821 This option tells @command{tar} to read or write archives through
2822 @command{lzma}. @xref{gzip}.
2826 This option tells @command{tar} to read or write archives through
2827 @command{lzop}. @xref{gzip}.
2830 @item --mode=@var{permissions}
2832 When adding files to an archive, @command{tar} will use
2833 @var{permissions} for the archive members, rather than the permissions
2834 from the files. @var{permissions} can be specified either as an octal
2835 number or as symbolic permissions, like with
2836 @command{chmod}. @xref{override}.
2839 @item --mtime=@var{date}
2841 When adding files to an archive, @command{tar} will use @var{date} as
2842 the modification time of members when creating archives, instead of
2843 their actual modification times. The value of @var{date} can be
2844 either a textual date representation (@pxref{Date input formats}) or a
2845 name of the existing file, starting with @samp{/} or @samp{.}. In the
2846 latter case, the modification time of that file is used. @xref{override}.
2848 @opsummary{multi-volume}
2849 @item --multi-volume
2852 Informs @command{tar} that it should create or otherwise operate on a
2853 multi-volume @command{tar} archive. @xref{Using Multiple Tapes}.
2855 @opsummary{new-volume-script}
2856 @item --new-volume-script
2861 @item --newer=@var{date}
2862 @itemx --after-date=@var{date}
2865 When creating an archive, @command{tar} will only add files that have changed
2866 since @var{date}. If @var{date} begins with @samp{/} or @samp{.}, it
2867 is taken to be the name of a file whose data modification time specifies
2868 the date. @xref{after}.
2870 @opsummary{newer-mtime}
2871 @item --newer-mtime=@var{date}
2873 Like @option{--newer}, but add only files whose
2874 contents have changed (as opposed to just @option{--newer}, which will
2875 also back up files for which any status information has
2876 changed). @xref{after}.
2878 @opsummary{no-anchored}
2880 An exclude pattern can match any subsequence of the name's components.
2881 @xref{controlling pattern-matching}.
2883 @opsummary{no-auto-compress}
2884 @item --no-auto-compress
2886 Disables automatic compressed format recognition based on the archive
2887 suffix. @xref{--auto-compress}. @xref{gzip}.
2889 @opsummary{no-check-device}
2890 @item --no-check-device
2891 Do not check device numbers when creating a list of modified files
2892 for incremental archiving. @xref{device numbers}, for
2893 a detailed description.
2895 @opsummary{no-delay-directory-restore}
2896 @item --no-delay-directory-restore
2898 Modification times and permissions of extracted
2899 directories are set when all files from this directory have been
2900 extracted. This is the default.
2901 @xref{Directory Modification Times and Permissions}.
2903 @opsummary{no-ignore-case}
2904 @item --no-ignore-case
2905 Use case-sensitive matching.
2906 @xref{controlling pattern-matching}.
2908 @opsummary{no-ignore-command-error}
2909 @item --no-ignore-command-error
2910 Print warnings about subprocesses that terminated with a nonzero exit
2911 code. @xref{Writing to an External Program}.
2916 If the @option{--null} option was given previously, this option
2917 cancels its effect, so that any following @option{--files-from}
2918 options will expect their file lists to be newline-terminated.
2920 @opsummary{no-overwrite-dir}
2921 @item --no-overwrite-dir
2923 Preserve metadata of existing directories when extracting files
2924 from an archive. @xref{Overwrite Old Files}.
2926 @opsummary{no-quote-chars}
2927 @item --no-quote-chars=@var{string}
2928 Remove characters listed in @var{string} from the list of quoted
2929 characters set by the previous @option{--quote-chars} option
2930 (@pxref{quoting styles}).
2932 @opsummary{no-recursion}
2933 @item --no-recursion
2935 With this option, @command{tar} will not recurse into directories.
2938 @opsummary{no-same-owner}
2939 @item --no-same-owner
2942 When extracting an archive, do not attempt to preserve the owner
2943 specified in the @command{tar} archive. This the default behavior
2946 @opsummary{no-same-permissions}
2947 @item --no-same-permissions
2949 When extracting an archive, subtract the user's umask from files from
2950 the permissions specified in the archive. This is the default behavior
2953 @opsummary{no-unquote}
2955 Treat all input file or member names literally, do not interpret
2956 escape sequences. @xref{input name quoting}.
2958 @opsummary{no-wildcards}
2959 @item --no-wildcards
2960 Do not use wildcards.
2961 @xref{controlling pattern-matching}.
2963 @opsummary{no-wildcards-match-slash}
2964 @item --no-wildcards-match-slash
2965 Wildcards do not match @samp{/}.
2966 @xref{controlling pattern-matching}.
2971 When @command{tar} is using the @option{--files-from} option, this option
2972 instructs @command{tar} to expect file names terminated with @acronym{NUL}, so
2973 @command{tar} can correctly work with file names that contain newlines.
2976 @opsummary{numeric-owner}
2977 @item --numeric-owner
2979 This option will notify @command{tar} that it should use numeric user
2980 and group IDs when creating a @command{tar} file, rather than names.
2984 The function of this option depends on the action @command{tar} is
2985 performing. When extracting files, @option{-o} is a synonym for
2986 @option{--no-same-owner}, i.e., it prevents @command{tar} from
2987 restoring ownership of files being extracted.
2989 When creating an archive, it is a synonym for
2990 @option{--old-archive}. This behavior is for compatibility
2991 with previous versions of @GNUTAR{}, and will be
2992 removed in future releases.
2994 @xref{Changes}, for more information.
2996 @opsummary{occurrence}
2997 @item --occurrence[=@var{number}]
2999 This option can be used in conjunction with one of the subcommands
3000 @option{--delete}, @option{--diff}, @option{--extract} or
3001 @option{--list} when a list of files is given either on the command
3002 line or via @option{-T} option.
3004 This option instructs @command{tar} to process only the @var{number}th
3005 occurrence of each named file. @var{Number} defaults to 1, so
3008 tar -x -f archive.tar --occurrence filename
3012 will extract the first occurrence of the member @file{filename} from @file{archive.tar}
3013 and will terminate without scanning to the end of the archive.
3015 @opsummary{old-archive}
3017 Synonym for @option{--format=v7}.
3019 @opsummary{one-file-system}
3020 @item --one-file-system
3021 Used when creating an archive. Prevents @command{tar} from recursing into
3022 directories that are on different file systems from the current
3025 @opsummary{overwrite}
3028 Overwrite existing files and directory metadata when extracting files
3029 from an archive. @xref{Overwrite Old Files}.
3031 @opsummary{overwrite-dir}
3032 @item --overwrite-dir
3034 Overwrite the metadata of existing directories when extracting files
3035 from an archive. @xref{Overwrite Old Files}.
3038 @item --owner=@var{user}
3040 Specifies that @command{tar} should use @var{user} as the owner of members
3041 when creating archives, instead of the user associated with the source
3042 file. @var{user} is first decoded as a user symbolic name, but if
3043 this interpretation fails, it has to be a decimal numeric user @acronym{ID}.
3046 This option does not affect extraction from archives.
3048 @opsummary{pax-option}
3049 @item --pax-option=@var{keyword-list}
3050 This option is meaningful only with @acronym{POSIX.1-2001} archives
3051 (@pxref{posix}). It modifies the way @command{tar} handles the
3052 extended header keywords. @var{Keyword-list} is a comma-separated
3053 list of keyword options. @xref{PAX keywords}, for a detailed
3056 @opsummary{portability}
3058 @itemx --old-archive
3059 Synonym for @option{--format=v7}.
3063 Same as @option{--format=posix}.
3065 @opsummary{preserve}
3068 Synonymous with specifying both @option{--preserve-permissions} and
3069 @option{--same-order}. @xref{Setting Access Permissions}.
3071 @opsummary{preserve-order}
3072 @item --preserve-order
3074 (See @option{--same-order}; @pxref{Reading}.)
3076 @opsummary{preserve-permissions}
3077 @opsummary{same-permissions}
3078 @item --preserve-permissions
3079 @itemx --same-permissions
3082 When @command{tar} is extracting an archive, it normally subtracts the
3083 users' umask from the permissions specified in the archive and uses
3084 that number as the permissions to create the destination file.
3085 Specifying this option instructs @command{tar} that it should use the
3086 permissions directly from the archive. @xref{Setting Access Permissions}.
3088 @opsummary{quote-chars}
3089 @item --quote-chars=@var{string}
3090 Always quote characters from @var{string}, even if the selected
3091 quoting style would not quote them (@pxref{quoting styles}).
3093 @opsummary{quoting-style}
3094 @item --quoting-style=@var{style}
3095 Set quoting style to use when printing member and file names
3096 (@pxref{quoting styles}). Valid @var{style} values are:
3097 @code{literal}, @code{shell}, @code{shell-always}, @code{c},
3098 @code{escape}, @code{locale}, and @code{clocale}. Default quoting
3099 style is @code{escape}, unless overridden while configuring the
3102 @opsummary{read-full-records}
3103 @item --read-full-records
3106 Specifies that @command{tar} should reblock its input, for reading
3107 from pipes on systems with buggy implementations. @xref{Reading}.
3109 @opsummary{record-size}
3110 @item --record-size=@var{size}
3112 Instructs @command{tar} to use @var{size} bytes per record when accessing the
3113 archive. @xref{Blocking Factor}.
3115 @opsummary{recursion}
3118 With this option, @command{tar} recurses into directories (default).
3121 @opsummary{recursive-unlink}
3122 @item --recursive-unlink
3125 directory hierarchies before extracting directories of the same name
3126 from the archive. @xref{Recursive Unlink}.
3128 @opsummary{remove-files}
3129 @item --remove-files
3131 Directs @command{tar} to remove the source file from the file system after
3132 appending it to an archive. @xref{remove files}.
3134 @opsummary{restrict}
3137 Disable use of some potentially harmful @command{tar} options.
3138 Currently this option disables shell invocation from multi-volume menu
3139 (@pxref{Using Multiple Tapes}).
3141 @opsummary{rmt-command}
3142 @item --rmt-command=@var{cmd}
3144 Notifies @command{tar} that it should use @var{cmd} instead of
3145 the default @file{/usr/libexec/rmt} (@pxref{Remote Tape Server}).
3147 @opsummary{rsh-command}
3148 @item --rsh-command=@var{cmd}
3150 Notifies @command{tar} that is should use @var{cmd} to communicate with remote
3151 devices. @xref{Device}.
3153 @opsummary{same-order}
3155 @itemx --preserve-order
3158 This option is an optimization for @command{tar} when running on machines with
3159 small amounts of memory. It informs @command{tar} that the list of file
3160 arguments has already been sorted to match the order of files in the
3161 archive. @xref{Reading}.
3163 @opsummary{same-owner}
3166 When extracting an archive, @command{tar} will attempt to preserve the owner
3167 specified in the @command{tar} archive with this option present.
3168 This is the default behavior for the superuser; this option has an
3169 effect only for ordinary users. @xref{Attributes}.
3171 @opsummary{same-permissions}
3172 @item --same-permissions
3174 (See @option{--preserve-permissions}; @pxref{Setting Access Permissions}.)
3180 Assume that the archive media supports seeks to arbitrary
3181 locations. Usually @command{tar} determines automatically whether
3182 the archive can be seeked or not. This option is intended for use
3183 in cases when such recognition fails.
3185 @opsummary{show-defaults}
3186 @item --show-defaults
3188 Displays the default options used by @command{tar} and exits
3189 successfully. This option is intended for use in shell scripts.
3190 Here is an example of what you can see using this option:
3193 $ tar --show-defaults
3194 --format=gnu -f- -b20 --quoting-style=escape \
3195 --rmt-command=/usr/libexec/rmt --rsh-command=/usr/bin/rsh
3198 @opsummary{show-omitted-dirs}
3199 @item --show-omitted-dirs
3201 Instructs @command{tar} to mention the directories it is skipping when
3202 operating on a @command{tar} archive. @xref{show-omitted-dirs}.
3204 @opsummary{show-transformed-names}
3205 @opsummary{show-stored-names}
3206 @item --show-transformed-names
3207 @itemx --show-stored-names
3209 Display file or member names after applying any transformations
3210 (@pxref{transform}). In particular, when used in conjunction with one of
3211 the archive creation operations it instructs @command{tar} to list the
3212 member names stored in the archive, as opposed to the actual file
3213 names. @xref{listing member and file names}.
3219 Invokes a @acronym{GNU} extension when adding files to an archive that handles
3220 sparse files efficiently. @xref{sparse}.
3222 @opsummary{sparse-version}
3223 @item --sparse-version=@var{version}
3225 Specifies the @dfn{format version} to use when archiving sparse
3226 files. Implies @option{--sparse}. @xref{sparse}. For the description
3227 of the supported sparse formats, @xref{Sparse Formats}.
3229 @opsummary{starting-file}
3230 @item --starting-file=@var{name}
3231 @itemx -K @var{name}
3233 This option affects extraction only; @command{tar} will skip extracting
3234 files in the archive until it finds one that matches @var{name}.
3237 @opsummary{strip-components}
3238 @item --strip-components=@var{number}
3239 Strip given @var{number} of leading components from file names before
3240 extraction. For example, if archive @file{archive.tar} contained
3241 @file{/some/file/name}, then running
3244 tar --extract --file archive.tar --strip-components=2
3248 would extract this file to file @file{name}.
3250 @opsummary{suffix}, summary
3251 @item --suffix=@var{suffix}
3253 Alters the suffix @command{tar} uses when backing up files from the default
3254 @samp{~}. @xref{backup}.
3256 @opsummary{tape-length}
3257 @item --tape-length=@var{num}
3260 Specifies the length of tapes that @command{tar} is writing as being
3261 @w{@var{num} x 1024} bytes long. @xref{Using Multiple Tapes}.
3263 @opsummary{test-label}
3266 Reads the volume label. If an argument is specified, test whether it
3267 matches the volume label. @xref{--test-label option}.
3269 @opsummary{to-command}
3270 @item --to-command=@var{command}
3272 During extraction @command{tar} will pipe extracted files to the
3273 standard input of @var{command}. @xref{Writing to an External Program}.
3275 @opsummary{to-stdout}
3279 During extraction, @command{tar} will extract files to stdout rather
3280 than to the file system. @xref{Writing to Standard Output}.
3283 @item --totals[=@var{signo}]
3285 Displays the total number of bytes transferred when processing an
3286 archive. If an argument is given, these data are displayed on
3287 request, when signal @var{signo} is delivered to @command{tar}.
3294 Sets the data modification time of extracted files to the extraction time,
3295 rather than the data modification time stored in the archive.
3296 @xref{Data Modification Times}.
3298 @opsummary{transform}
3300 @item --transform=@var{sed-expr}
3301 @itemx --xform=@var{sed-expr}
3302 Transform file or member names using @command{sed} replacement expression
3303 @var{sed-expr}. For example,
3306 $ @kbd{tar cf archive.tar --transform 's,^\./,usr/,' .}
3310 will add to @file{archive} files from the current working directory,
3311 replacing initial @samp{./} prefix with @samp{usr/}. For the detailed
3312 discussion, @xref{transform}.
3314 To see transformed member names in verbose listings, use
3315 @option{--show-transformed-names} option
3316 (@pxref{show-transformed-names}).
3318 @opsummary{uncompress}
3321 (See @option{--compress}. @pxref{gzip})
3326 (See @option{--gzip}. @pxref{gzip})
3328 @opsummary{unlink-first}
3329 @item --unlink-first
3332 Directs @command{tar} to remove the corresponding file from the file
3333 system before extracting it from the archive. @xref{Unlink First}.
3337 Enable unquoting input file or member names (default). @xref{input
3340 @opsummary{use-compress-program}
3341 @item --use-compress-program=@var{prog}
3342 @itemx -I=@var{prog}
3344 Instructs @command{tar} to access the archive through @var{prog}, which is
3345 presumed to be a compression program of some sort. @xref{gzip}.
3350 Display file modification dates in @acronym{UTC}. This option implies
3357 Specifies that @command{tar} should be more verbose about the
3358 operations it is performing. This option can be specified multiple
3359 times for some operations to increase the amount of information displayed.
3366 Verifies that the archive was correctly written when creating an
3367 archive. @xref{verify}.
3372 Print information about the program's name, version, origin and legal
3373 status, all on standard output, and then exit successfully.
3376 @opsummary{volno-file}
3377 @item --volno-file=@var{file}
3379 Used in conjunction with @option{--multi-volume}. @command{tar} will
3380 keep track of which volume of a multi-volume archive it is working in
3381 @var{file}. @xref{volno-file}.
3384 @item --warning=@var{keyword}
3386 Enable or disable warning messages identified by @var{keyword}. The
3387 messages are suppressed if @var{keyword} is prefixed with @samp{no-}.
3390 @opsummary{wildcards}
3392 Use wildcards when matching member names with patterns.
3393 @xref{controlling pattern-matching}.
3395 @opsummary{wildcards-match-slash}
3396 @item --wildcards-match-slash
3397 Wildcards match @samp{/}.
3398 @xref{controlling pattern-matching}.
3403 Use @command{xz} for compressing or decompressing the archives. @xref{gzip}.
3407 @node Short Option Summary
3408 @subsection Short Options Cross Reference
3410 Here is an alphabetized list of all of the short option forms, matching
3411 them with the equivalent long option.
3413 @multitable @columnfractions 0.20 0.80
3414 @headitem Short Option @tab Reference
3416 @item -A @tab @ref{--concatenate}.
3418 @item -B @tab @ref{--read-full-records}.
3420 @item -C @tab @ref{--directory}.
3422 @item -F @tab @ref{--info-script}.
3424 @item -G @tab @ref{--incremental}.
3426 @item -J @tab @ref{--xz}.
3428 @item -K @tab @ref{--starting-file}.
3430 @item -L @tab @ref{--tape-length}.
3432 @item -M @tab @ref{--multi-volume}.
3434 @item -N @tab @ref{--newer}.
3436 @item -O @tab @ref{--to-stdout}.
3438 @item -P @tab @ref{--absolute-names}.
3440 @item -R @tab @ref{--block-number}.
3442 @item -S @tab @ref{--sparse}.
3444 @item -T @tab @ref{--files-from}.
3446 @item -U @tab @ref{--unlink-first}.
3448 @item -V @tab @ref{--label}.
3450 @item -W @tab @ref{--verify}.
3452 @item -X @tab @ref{--exclude-from}.
3454 @item -Z @tab @ref{--compress}.
3456 @item -b @tab @ref{--blocking-factor}.
3458 @item -c @tab @ref{--create}.
3460 @item -d @tab @ref{--compare}.
3462 @item -f @tab @ref{--file}.
3464 @item -g @tab @ref{--listed-incremental}.
3466 @item -h @tab @ref{--dereference}.
3468 @item -i @tab @ref{--ignore-zeros}.
3470 @item -j @tab @ref{--bzip2}.
3472 @item -k @tab @ref{--keep-old-files}.
3474 @item -l @tab @ref{--check-links}.
3476 @item -m @tab @ref{--touch}.
3478 @item -o @tab When creating, @ref{--no-same-owner}, when extracting ---
3479 @ref{--portability}.
3481 The latter usage is deprecated. It is retained for compatibility with
3482 the earlier versions of @GNUTAR{}. In future releases
3483 @option{-o} will be equivalent to @option{--no-same-owner} only.
3485 @item -p @tab @ref{--preserve-permissions}.
3487 @item -r @tab @ref{--append}.
3489 @item -s @tab @ref{--same-order}.
3491 @item -t @tab @ref{--list}.
3493 @item -u @tab @ref{--update}.
3495 @item -v @tab @ref{--verbose}.
3497 @item -w @tab @ref{--interactive}.
3499 @item -x @tab @ref{--extract}.
3501 @item -z @tab @ref{--gzip}.
3506 @section @GNUTAR{} documentation
3508 @cindex Getting program version number
3510 @cindex Version of the @command{tar} program
3511 Being careful, the first thing is really checking that you are using
3512 @GNUTAR{}, indeed. The @option{--version} option
3513 causes @command{tar} to print information about its name, version,
3514 origin and legal status, all on standard output, and then exit
3515 successfully. For example, @w{@samp{tar --version}} might print:
3518 tar (GNU tar) @value{VERSION}
3519 Copyright (C) 2008 Free Software Foundation, Inc.
3520 This is free software. You may redistribute copies of it under the terms
3521 of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
3522 There is NO WARRANTY, to the extent permitted by law.
3524 Written by John Gilmore and Jay Fenlason.
3528 The first occurrence of @samp{tar} in the result above is the program
3529 name in the package (for example, @command{rmt} is another program),
3530 while the second occurrence of @samp{tar} is the name of the package
3531 itself, containing possibly many programs. The package is currently
3532 named @samp{tar}, after the name of the main program it
3533 contains@footnote{There are plans to merge the @command{cpio} and
3534 @command{tar} packages into a single one which would be called
3535 @code{paxutils}. So, who knows if, one of this days, the
3536 @option{--version} would not output @w{@samp{tar (@acronym{GNU}
3539 @cindex Obtaining help
3540 @cindex Listing all @command{tar} options
3541 @xopindex{help, introduction}
3542 Another thing you might want to do is checking the spelling or meaning
3543 of some particular @command{tar} option, without resorting to this
3544 manual, for once you have carefully read it. @GNUTAR{}
3545 has a short help feature, triggerable through the
3546 @option{--help} option. By using this option, @command{tar} will
3547 print a usage message listing all available options on standard
3548 output, then exit successfully, without doing anything else and
3549 ignoring all other options. Even if this is only a brief summary, it
3550 may be several screens long. So, if you are not using some kind of
3551 scrollable window, you might prefer to use something like:
3554 $ @kbd{tar --help | less}
3558 presuming, here, that you like using @command{less} for a pager. Other
3559 popular pagers are @command{more} and @command{pg}. If you know about some
3560 @var{keyword} which interests you and do not want to read all the
3561 @option{--help} output, another common idiom is doing:
3564 tar --help | grep @var{keyword}
3568 for getting only the pertinent lines. Notice, however, that some
3569 @command{tar} options have long description lines and the above
3570 command will list only the first of them.
3572 The exact look of the option summary displayed by @kbd{tar --help} is
3573 configurable. @xref{Configuring Help Summary}, for a detailed description.
3576 If you only wish to check the spelling of an option, running @kbd{tar
3577 --usage} may be a better choice. This will display a terse list of
3578 @command{tar} option without accompanying explanations.
3580 The short help output is quite succinct, and you might have to get
3581 back to the full documentation for precise points. If you are reading
3582 this paragraph, you already have the @command{tar} manual in some
3583 form. This manual is available in a variety of forms from
3584 @url{http://www.gnu.org/software/tar/manual}. It may be printed out of the @GNUTAR{}
3585 distribution, provided you have @TeX{} already installed somewhere,
3586 and a laser printer around. Just configure the distribution, execute
3587 the command @w{@samp{make dvi}}, then print @file{doc/tar.dvi} the
3588 usual way (contact your local guru to know how). If @GNUTAR{}
3589 has been conveniently installed at your place, this
3590 manual is also available in interactive, hypertextual form as an Info
3591 file. Just call @w{@samp{info tar}} or, if you do not have the
3592 @command{info} program handy, use the Info reader provided within
3593 @acronym{GNU} Emacs, calling @samp{tar} from the main Info menu.
3595 There is currently no @code{man} page for @GNUTAR{}.
3596 If you observe such a @code{man} page on the system you are running,
3597 either it does not belong to @GNUTAR{}, or it has not
3598 been produced by @acronym{GNU}. Some package maintainers convert
3599 @kbd{tar --help} output to a man page, using @command{help2man}. In
3600 any case, please bear in mind that the authoritative source of
3601 information about @GNUTAR{} is this Texinfo documentation.
3604 @section Obtaining @GNUTAR{} default values
3606 @opindex show-defaults
3607 @GNUTAR{} has some predefined defaults that are used when you do not
3608 explicitly specify another values. To obtain a list of such
3609 defaults, use @option{--show-defaults} option. This will output the
3610 values in the form of @command{tar} command line options:
3614 @kbd{tar --show-defaults}
3615 --format=gnu -f- -b20 --quoting-style=escape
3616 --rmt-command=/etc/rmt --rsh-command=/usr/bin/rsh
3621 Notice, that this option outputs only one line. The example output above
3622 has been split to fit page boundaries.
3625 The above output shows that this version of @GNUTAR{} defaults to
3626 using @samp{gnu} archive format (@pxref{Formats}), it uses standard
3627 output as the archive, if no @option{--file} option has been given
3628 (@pxref{file tutorial}), the default blocking factor is 20
3629 (@pxref{Blocking Factor}). It also shows the default locations where
3630 @command{tar} will look for @command{rmt} and @command{rsh} binaries.
3633 @section Checking @command{tar} progress
3635 Typically, @command{tar} performs most operations without reporting any
3636 information to the user except error messages. When using @command{tar}
3637 with many options, particularly ones with complicated or
3638 difficult-to-predict behavior, it is possible to make serious mistakes.
3639 @command{tar} provides several options that make observing @command{tar}
3640 easier. These options cause @command{tar} to print information as it
3641 progresses in its job, and you might want to use them just for being
3642 more careful about what is going on, or merely for entertaining
3643 yourself. If you have encountered a problem when operating on an
3644 archive, however, you may need more information than just an error
3645 message in order to solve the problem. The following options can be
3646 helpful diagnostic tools.
3648 @cindex Verbose operation
3650 Normally, the @option{--list} (@option{-t}) command to list an archive
3651 prints just the file names (one per line) and the other commands are
3652 silent. When used with most operations, the @option{--verbose}
3653 (@option{-v}) option causes @command{tar} to print the name of each
3654 file or archive member as it is processed. This and the other options
3655 which make @command{tar} print status information can be useful in
3656 monitoring @command{tar}.
3658 With @option{--create} or @option{--extract}, @option{--verbose} used
3659 once just prints the names of the files or members as they are processed.
3660 Using it twice causes @command{tar} to print a longer listing
3661 (@xref{verbose member listing}, for the description) for each member.
3662 Since @option{--list} already prints the names of the members,
3663 @option{--verbose} used once with @option{--list} causes @command{tar}
3664 to print an @samp{ls -l} type listing of the files in the archive.
3665 The following examples both extract members with long list output:
3668 $ @kbd{tar --extract --file=archive.tar --verbose --verbose}
3669 $ @kbd{tar xvvf archive.tar}
3672 Verbose output appears on the standard output except when an archive is
3673 being written to the standard output, as with @samp{tar --create
3674 --file=- --verbose} (@samp{tar cfv -}, or even @samp{tar cv}---if the
3675 installer let standard output be the default archive). In that case
3676 @command{tar} writes verbose output to the standard error stream.
3678 If @option{--index-file=@var{file}} is specified, @command{tar} sends
3679 verbose output to @var{file} rather than to standard output or standard
3683 @cindex Obtaining total status information
3685 The @option{--totals} option causes @command{tar} to print on the
3686 standard error the total amount of bytes transferred when processing
3687 an archive. When creating or appending to an archive, this option
3688 prints the number of bytes written to the archive and the average
3689 speed at which they have been written, e.g.:
3693 $ @kbd{tar -c -f archive.tar --totals /home}
3694 Total bytes written: 7924664320 (7.4GiB, 85MiB/s)
3698 When reading an archive, this option displays the number of bytes
3703 $ @kbd{tar -x -f archive.tar --totals}
3704 Total bytes read: 7924664320 (7.4GiB, 95MiB/s)
3708 Finally, when deleting from an archive, the @option{--totals} option
3709 displays both numbers plus number of bytes removed from the archive:
3713 $ @kbd{tar --delete -f foo.tar --totals --wildcards '*~'}
3714 Total bytes read: 9543680 (9.2MiB, 201MiB/s)
3715 Total bytes written: 3829760 (3.7MiB, 81MiB/s)
3716 Total bytes deleted: 1474048
3720 You can also obtain this information on request. When
3721 @option{--totals} is used with an argument, this argument is
3722 interpreted as a symbolic name of a signal, upon delivery of which the
3723 statistics is to be printed:
3726 @item --totals=@var{signo}
3727 Print statistics upon delivery of signal @var{signo}. Valid arguments
3728 are: @code{SIGHUP}, @code{SIGQUIT}, @code{SIGINT}, @code{SIGUSR1} and
3729 @code{SIGUSR2}. Shortened names without @samp{SIG} prefix are also
3733 Both forms of @option{--totals} option can be used simultaneously.
3734 Thus, @kbd{tar -x --totals --totals=USR1} instructs @command{tar} to
3735 extract all members from its default archive and print statistics
3736 after finishing the extraction, as well as when receiving signal
3739 @anchor{Progress information}
3740 @cindex Progress information
3741 The @option{--checkpoint} option prints an occasional message
3742 as @command{tar} reads or writes the archive. It is designed for
3743 those who don't need the more detailed (and voluminous) output of
3744 @option{--block-number} (@option{-R}), but do want visual confirmation
3745 that @command{tar} is actually making forward progress. By default it
3746 prints a message each 10 records read or written. This can be changed
3747 by giving it a numeric argument after an equal sign:
3750 $ @kbd{tar -c --checkpoint=1000} /var
3751 tar: Write checkpoint 1000
3752 tar: Write checkpoint 2000
3753 tar: Write checkpoint 3000
3756 This example shows the default checkpoint message used by
3757 @command{tar}. If you place a dot immediately after the equal
3758 sign, it will print a @samp{.} at each checkpoint@footnote{This is
3759 actually a shortcut for @option{--checkpoint=@var{n}
3760 --checkpoint-action=dot}. @xref{checkpoints, dot}.}. For example:
3763 $ @kbd{tar -c --checkpoint=.1000} /var
3767 The @option{--checkpoint} option provides a flexible mechanism for
3768 executing arbitrary actions upon hitting checkpoints, see the next
3769 section (@pxref{checkpoints}), for more information on it.
3771 @opindex show-omitted-dirs
3772 @anchor{show-omitted-dirs}
3773 The @option{--show-omitted-dirs} option, when reading an archive---with
3774 @option{--list} or @option{--extract}, for example---causes a message
3775 to be printed for each directory in the archive which is skipped.
3776 This happens regardless of the reason for skipping: the directory might
3777 not have been named on the command line (implicitly or explicitly),
3778 it might be excluded by the use of the
3779 @option{--exclude=@var{pattern}} option, or some other reason.
3781 @opindex block-number
3782 @cindex Block number where error occurred
3783 @anchor{block-number}
3784 If @option{--block-number} (@option{-R}) is used, @command{tar} prints, along with
3785 every message it would normally produce, the block number within the
3786 archive where the message was triggered. Also, supplementary messages
3787 are triggered when reading blocks full of NULs, or when hitting end of
3788 file on the archive. As of now, if the archive is properly terminated
3789 with a NUL block, the reading of the file may stop before end of file
3790 is met, so the position of end of file will not usually show when
3791 @option{--block-number} (@option{-R}) is used. Note that @GNUTAR{}
3792 drains the archive before exiting when reading the
3793 archive from a pipe.
3795 @cindex Error message, block number of
3796 This option is especially useful when reading damaged archives, since
3797 it helps pinpoint the damaged sections. It can also be used with
3798 @option{--list} (@option{-t}) when listing a file-system backup tape, allowing you to
3799 choose among several backup tapes when retrieving a file later, in
3800 favor of the tape where the file appears earliest (closest to the
3801 front of the tape). @xref{backup}.
3804 @section Checkpoints
3805 @cindex checkpoints, defined
3807 @opindex checkpoint-action
3809 A @dfn{checkpoint} is a moment of time before writing @var{n}th record to
3810 the archive (a @dfn{write checkpoint}), or before reading @var{n}th record
3811 from the archive (a @dfn{read checkpoint}). Checkpoints allow to
3812 periodically execute arbitrary actions.
3814 The checkpoint facility is enabled using the following option:
3817 @xopindex{checkpoint, defined}
3818 @item --checkpoint[=@var{n}]
3819 Schedule checkpoints before writing or reading each @var{n}th record.
3820 The default value for @var{n} is 10.
3823 A list of arbitrary @dfn{actions} can be executed at each checkpoint.
3824 These actions include: pausing, displaying textual messages, and
3825 executing arbitrary external programs. Actions are defined using
3826 the @option{--checkpoint-action} option.
3829 @xopindex{checkpoint-action, defined}
3830 @item --checkpoint-action=@var{action}
3831 Execute an @var{action} at each checkpoint.
3834 @cindex @code{echo}, checkpoint action
3835 The simplest value of @var{action} is @samp{echo}. It instructs
3836 @command{tar} to display the default message on the standard error
3837 stream upon arriving at each checkpoint. The default message is (in
3838 @acronym{POSIX} locale) @samp{Write checkpoint @var{n}}, for write
3839 checkpoints, and @samp{Read checkpoint @var{n}}, for read checkpoints.
3840 Here, @var{n} represents ordinal number of the checkpoint.
3842 In another locales, translated versions of this message are used.
3844 This is the default action, so running:
3847 $ @kbd{tar -c --checkpoint=1000 --checkpoint-action=echo} /var
3854 $ @kbd{tar -c --checkpoint=1000} /var
3857 The @samp{echo} action also allows to supply a customized message.
3858 You do so by placing an equals sign and the message right after it,
3862 --checkpoint-action="echo=Hit %s checkpoint #%u"
3865 The @samp{%s} and @samp{%u} in the above example are
3866 @dfn{meta-characters}. The @samp{%s} meta-character is replaced with
3867 the @dfn{type} of the checkpoint: @samp{write} or
3868 @samp{read} (or a corresponding translated version in locales other
3869 than @acronym{POSIX}). The @samp{%u} meta-character is replaced with
3870 the ordinal number of the checkpoint. Thus, the above example could
3871 produce the following output when used with the @option{--create}
3875 tar: Hit write checkpoint #10
3876 tar: Hit write checkpoint #20
3877 tar: Hit write checkpoint #30
3880 Aside from meta-character expansion, the message string is subject to
3881 @dfn{unquoting}, during which the backslash @dfn{escape sequences} are
3882 replaced with their corresponding @acronym{ASCII} characters
3883 (@pxref{escape sequences}). E.g. the following action will produce an
3884 audible bell and the message described above at each checkpoint:
3887 --checkpoint-action='echo=\aHit %s checkpoint #%u'
3890 @cindex @code{bell}, checkpoint action
3891 There is also a special action which produces an audible signal:
3892 @samp{bell}. It is not equivalent to @samp{echo='\a'}, because
3893 @samp{bell} sends the bell directly to the console (@file{/dev/tty}),
3894 whereas @samp{echo='\a'} sends it to the standard error.
3896 @cindex @code{ttyout}, checkpoint action
3897 The @samp{ttyout=@var{string}} action outputs @var{string} to
3898 @file{/dev/tty}, so it can be used even if the standard output is
3899 redirected elsewhere. The @var{string} is subject to the same
3900 modifications as with @samp{echo} action. In contrast to the latter,
3901 @samp{ttyout} does not prepend @command{tar} executable name to the
3902 string, nor does it output a newline after it. For example, the
3903 following action will print the checkpoint message at the same screen
3904 line, overwriting any previous message:
3907 --checkpoint-action="ttyout=\rHit %s checkpoint #%u"
3910 @cindex @code{dot}, checkpoint action
3911 Another available checkpoint action is @samp{dot} (or @samp{.}). It
3912 instructs @command{tar} to print a single dot on the standard listing
3916 $ @kbd{tar -c --checkpoint=1000 --checkpoint-action=dot} /var
3920 For compatibility with previous @GNUTAR{} versions, this action can
3921 be abbreviated by placing a dot in front of the checkpoint frequency,
3922 as shown in the previous section.
3924 @cindex @code{sleep}, checkpoint action
3925 Yet another action, @samp{sleep}, pauses @command{tar} for a specified
3926 amount of seconds. The following example will stop for 30 seconds at each
3930 $ @kbd{tar -c --checkpoint=1000 --checkpoint-action=sleep=30}
3933 @cindex @code{exec}, checkpoint action
3934 Finally, the @code{exec} action executes a given external program.
3938 $ @kbd{tar -c --checkpoint=1000 --checkpoint-action=exec=/sbin/cpoint}
3941 This program is executed using @command{/bin/sh -c}, with no
3942 additional arguments. Its exit code is ignored. It gets a copy of
3943 @command{tar}'s environment plus the following variables:
3946 @vrindex TAR_VERSION, checkpoint script environment
3948 @GNUTAR{} version number.
3950 @vrindex TAR_ARCHIVE, checkpoint script environment
3952 The name of the archive @command{tar} is processing.
3954 @vrindex TAR_BLOCKING_FACTOR, checkpoint script environment
3955 @item TAR_BLOCKING_FACTOR
3956 Current blocking factor (@pxref{Blocking}).
3958 @vrindex TAR_CHECKPOINT, checkpoint script environment
3959 @item TAR_CHECKPOINT
3960 Number of the checkpoint.
3962 @vrindex TAR_SUBCOMMAND, checkpoint script environment
3963 @item TAR_SUBCOMMAND
3964 A short option describing the operation @command{tar} is executing.
3965 @xref{Operations}, for a complete list of subcommand options.
3967 @vrindex TAR_FORMAT, checkpoint script environment
3969 Format of the archive being processed. @xref{Formats}, for a complete
3970 list of archive format names.
3973 Any number of actions can be defined, by supplying several
3974 @option{--checkpoint-action} options in the command line. For
3975 example, the command below displays two messages, pauses
3976 execution for 30 seconds and executes the @file{/sbin/cpoint} script:
3980 $ @kbd{tar -c -f arc.tar \
3981 --checkpoint-action='\aecho=Hit %s checkpoint #%u' \
3982 --checkpoint-action='echo=Sleeping for 30 seconds' \
3983 --checkpoint-action='sleep=30' \
3984 --checkpoint-action='exec=/sbin/cpoint'}
3988 This example also illustrates the fact that
3989 @option{--checkpoint-action} can be used without
3990 @option{--checkpoint}. In this case, the default checkpoint frequency
3991 (at each 10th record) is assumed.
3994 @section Controlling Warning Messages
3996 Sometimes, while performing the requested task, @GNUTAR{} notices
3997 some conditions that are not exactly erros, but which the user
3998 should be aware of. When this happens, @command{tar} issues a
3999 @dfn{warning message} describing the condition. Warning messages
4000 are output to the standard error and they do not affect the exit
4001 code of @command{tar} command.
4003 @xopindex{warning, explained}
4004 @GNUTAR{} allows the user to suppress some or all of its warning
4008 @item --warning=@var{keyword}
4009 Control display of the warning messages identified by @var{keyword}.
4010 If @var{keyword} starts with the prefix @samp{no-}, such messages are
4011 suppressed. Otherwise, they are enabled.
4013 Multiple @option{--warning} messages accumulate.
4015 The tables below list allowed values for @var{keyword} along with the
4016 warning messages they control.
4019 @subheading Keywords controlling @command{tar} operation
4023 Enable all warning messages. This is the default.
4026 Disable all warning messages.
4027 @kwindex filename-with-nuls
4028 @cindex @samp{file name read contains nul character}, warning message
4029 @item filename-with-nuls
4030 @samp{%s: file name read contains nul character}
4031 @kwindex alone-zero-block
4032 @cindex @samp{A lone zero block at}, warning message
4033 @item alone-zero-block
4034 @samp{A lone zero block at %s}
4037 @subheading Keywords applicable for @command{tar --create}
4040 @cindex @samp{contains a cache directory tag}, warning message
4042 @samp{%s: contains a cache directory tag %s; %s}
4043 @kwindex file-shrank
4044 @cindex @samp{File shrank by %s bytes}, warning message
4046 @samp{%s: File shrank by %s bytes; padding with zeros}
4048 @cindex @samp{file is on a different filesystem}, warning message
4050 @samp{%s: file is on a different filesystem; not dumped}
4051 @kwindex file-ignored
4052 @cindex @samp{Unknown file type; file ignored}, warning message
4053 @cindex @samp{socket ignored}, warning message
4054 @cindex @samp{door ignored}, warning message
4056 @samp{%s: Unknown file type; file ignored}
4057 @samp{%s: socket ignored}
4058 @*@samp{%s: door ignored}
4059 @kwindex file-unchanged
4060 @cindex @samp{file is unchanged; not dumped}, warning message
4061 @item file-unchanged
4062 @samp{%s: file is unchanged; not dumped}
4063 @kwindex ignore-archive
4064 @cindex @samp{file is the archive; not dumped}, warning message
4065 @kwindex ignore-archive
4066 @cindex @samp{file is the archive; not dumped}, warning message
4067 @item ignore-archive
4068 @samp{%s: file is the archive; not dumped}
4069 @kwindex file-removed
4070 @cindex @samp{File removed before we read it}, warning message
4072 @samp{%s: File removed before we read it}
4073 @kwindex file-changed
4074 @cindex @samp{file changed as we read it}, warning message
4076 @samp{%s: file changed as we read it}
4079 @subheading Keywords applicable for @command{tar --extract}
4082 @cindex @samp{implausibly old time stamp %s}, warning message
4083 @cindex @samp{time stamp %s is %s s in the future}, warning message
4085 @samp{%s: implausibly old time stamp %s}
4086 @*@samp{%s: time stamp %s is %s s in the future}
4087 @kwindex contiguous-cast
4088 @cindex @samp{Extracting contiguous files as regular files}, warning message
4089 @item contiguous-cast
4090 @samp{Extracting contiguous files as regular files}
4091 @kwindex symlink-cast
4092 @cindex @samp{Attempting extraction of symbolic links as hard links}, warning message
4094 @samp{Attempting extraction of symbolic links as hard links}
4095 @kwindex unknown-cast
4096 @cindex @samp{Unknown file type `%c', extracted as normal file}, warning message
4098 @samp{%s: Unknown file type `%c', extracted as normal file}
4099 @kwindex ignore-newer
4100 @cindex @samp{Current %s is newer or same age}, warning message
4102 @samp{Current %s is newer or same age}
4103 @kwindex unknown-keyword
4104 @cindex @samp{Ignoring unknown extended header keyword `%s'}, warning message
4105 @item unknown-keyword
4106 @samp{Ignoring unknown extended header keyword `%s'}
4109 @subheading Keywords controlling incremental extraction:
4111 @kwindex rename-directory
4112 @cindex @samp{%s: Directory has been renamed from %s}, warning message
4113 @cindex @samp{%s: Directory has been renamed}, warning message
4114 @item rename-directory
4115 @samp{%s: Directory has been renamed from %s}
4116 @*@samp{%s: Directory has been renamed}
4117 @kwindex new-directory
4118 @cindex @samp{%s: Directory is new}, warning message
4120 @samp{%s: Directory is new}
4122 @cindex @samp{%s: directory is on a different device: not purging}, warning message
4124 @samp{%s: directory is on a different device: not purging}
4125 @kwindex bad-dumpdir
4126 @cindex @samp{Malformed dumpdir: 'X' never used}, warning message
4128 @samp{Malformed dumpdir: 'X' never used}
4132 @section Asking for Confirmation During Operations
4133 @cindex Interactive operation
4135 Typically, @command{tar} carries out a command without stopping for
4136 further instructions. In some situations however, you may want to
4137 exclude some files and archive members from the operation (for instance
4138 if disk or storage space is tight). You can do this by excluding
4139 certain files automatically (@pxref{Choosing}), or by performing
4140 an operation interactively, using the @option{--interactive} (@option{-w}) option.
4141 @command{tar} also accepts @option{--confirmation} for this option.
4143 @opindex interactive
4144 When the @option{--interactive} (@option{-w}) option is specified, before
4145 reading, writing, or deleting files, @command{tar} first prints a message
4146 for each such file, telling what operation it intends to take, then asks
4147 for confirmation on the terminal. The actions which require
4148 confirmation include adding a file to the archive, extracting a file
4149 from the archive, deleting a file from the archive, and deleting a file
4150 from disk. To confirm the action, you must type a line of input
4151 beginning with @samp{y}. If your input line begins with anything other
4152 than @samp{y}, @command{tar} skips that file.
4154 If @command{tar} is reading the archive from the standard input,
4155 @command{tar} opens the file @file{/dev/tty} to support the interactive
4158 Verbose output is normally sent to standard output, separate from
4159 other error messages. However, if the archive is produced directly
4160 on standard output, then verbose output is mixed with errors on
4161 @code{stderr}. Producing the archive on standard output may be used
4162 as a way to avoid using disk space, when the archive is soon to be
4163 consumed by another process reading it, say. Some people felt the need
4164 of producing an archive on stdout, still willing to segregate between
4165 verbose output and error output. A possible approach would be using a
4166 named pipe to receive the archive, and having the consumer process to
4167 read from that named pipe. This has the advantage of letting standard
4168 output free to receive verbose output, all separate from errors.
4171 @chapter @GNUTAR{} Operations
4184 @section Basic @GNUTAR{} Operations
4186 The basic @command{tar} operations, @option{--create} (@option{-c}),
4187 @option{--list} (@option{-t}) and @option{--extract} (@option{--get},
4188 @option{-x}), are currently presented and described in the tutorial
4189 chapter of this manual. This section provides some complementary notes
4190 for these operations.
4193 @xopindex{create, complementary notes}
4197 Creating an empty archive would have some kind of elegance. One can
4198 initialize an empty archive and later use @option{--append}
4199 (@option{-r}) for adding all members. Some applications would not
4200 welcome making an exception in the way of adding the first archive
4201 member. On the other hand, many people reported that it is
4202 dangerously too easy for @command{tar} to destroy a magnetic tape with
4203 an empty archive@footnote{This is well described in @cite{Unix-haters
4204 Handbook}, by Simson Garfinkel, Daniel Weise & Steven Strassmann, IDG
4205 Books, ISBN 1-56884-203-1.}. The two most common errors are:
4209 Mistakingly using @code{create} instead of @code{extract}, when the
4210 intent was to extract the full contents of an archive. This error
4211 is likely: keys @kbd{c} and @kbd{x} are right next to each other on
4212 the QWERTY keyboard. Instead of being unpacked, the archive then
4213 gets wholly destroyed. When users speak about @dfn{exploding} an
4214 archive, they usually mean something else :-).
4217 Forgetting the argument to @code{file}, when the intent was to create
4218 an archive with a single file in it. This error is likely because a
4219 tired user can easily add the @kbd{f} key to the cluster of option
4220 letters, by the mere force of habit, without realizing the full
4221 consequence of doing so. The usual consequence is that the single
4222 file, which was meant to be saved, is rather destroyed.
4225 So, recognizing the likelihood and the catastrophic nature of these
4226 errors, @GNUTAR{} now takes some distance from elegance, and
4227 cowardly refuses to create an archive when @option{--create} option is
4228 given, there are no arguments besides options, and
4229 @option{--files-from} (@option{-T}) option is @emph{not} used. To get
4230 around the cautiousness of @GNUTAR{} and nevertheless create an
4231 archive with nothing in it, one may still use, as the value for the
4232 @option{--files-from} option, a file with no names in it, as shown in
4233 the following commands:
4236 @kbd{tar --create --file=empty-archive.tar --files-from=/dev/null}
4237 @kbd{tar cfT empty-archive.tar /dev/null}
4240 @xopindex{extract, complementary notes}
4245 A socket is stored, within a @GNUTAR{} archive, as a pipe.
4247 @item @option{--list} (@option{-t})
4249 @GNUTAR{} now shows dates as @samp{1996-08-30},
4250 while it used to show them as @samp{Aug 30 1996}. Preferably,
4251 people should get used to ISO 8601 dates. Local American dates should
4252 be made available again with full date localization support, once
4253 ready. In the meantime, programs not being localizable for dates
4254 should prefer international dates, that's really the way to go.
4256 Look up @url{http://www.cl.cam.ac.uk/@/~mgk25/@/iso-time.html} if you
4257 are curious, it contains a detailed explanation of the ISO 8601 standard.
4262 @section Advanced @GNUTAR{} Operations
4264 Now that you have learned the basics of using @GNUTAR{}, you may want
4265 to learn about further ways in which @command{tar} can help you.
4267 This chapter presents five, more advanced operations which you probably
4268 won't use on a daily basis, but which serve more specialized functions.
4269 We also explain the different styles of options and why you might want
4270 to use one or another, or a combination of them in your @command{tar}
4271 commands. Additionally, this chapter includes options which allow you to
4272 define the output from @command{tar} more carefully, and provide help and
4273 error correction in special circumstances.
4275 @FIXME{check this after the chapter is actually revised to make sure
4276 it still introduces the info in the chapter correctly : ).}
4288 @subsection The Five Advanced @command{tar} Operations
4290 @cindex basic operations
4291 In the last chapter, you learned about the first three operations to
4292 @command{tar}. This chapter presents the remaining five operations to
4293 @command{tar}: @option{--append}, @option{--update}, @option{--concatenate},
4294 @option{--delete}, and @option{--compare}.
4296 You are not likely to use these operations as frequently as those
4297 covered in the last chapter; however, since they perform specialized
4298 functions, they are quite useful when you do need to use them. We
4299 will give examples using the same directory and files that you created
4300 in the last chapter. As you may recall, the directory is called
4301 @file{practice}, the files are @samp{jazz}, @samp{blues}, @samp{folk},
4302 @samp{rock}, and the two archive files you created are
4303 @samp{collection.tar} and @samp{music.tar}.
4305 We will also use the archive files @samp{afiles.tar} and
4306 @samp{bfiles.tar}. The archive @samp{afiles.tar} contains the members @samp{apple},
4307 @samp{angst}, and @samp{aspic}; @samp{bfiles.tar} contains the members
4308 @samp{./birds}, @samp{baboon}, and @samp{./box}.
4310 Unless we state otherwise, all practicing you do and examples you follow
4311 in this chapter will take place in the @file{practice} directory that
4312 you created in the previous chapter; see @ref{prepare for examples}.
4313 (Below in this section, we will remind you of the state of the examples
4314 where the last chapter left them.)
4316 The five operations that we will cover in this chapter are:
4321 Add new entries to an archive that already exists.
4324 Add more recent copies of archive members to the end of an archive, if
4329 Add one or more pre-existing archives to the end of another archive.
4331 Delete items from an archive (does not work on tapes).
4335 Compare archive members to their counterparts in the file system.
4339 @subsection How to Add Files to Existing Archives: @option{--append}
4341 @cindex appending files to existing archive
4343 If you want to add files to an existing archive, you don't need to
4344 create a new archive; you can use @option{--append} (@option{-r}).
4345 The archive must already exist in order to use @option{--append}. (A
4346 related operation is the @option{--update} operation; you can use this
4347 to add newer versions of archive members to an existing archive. To learn how to
4348 do this with @option{--update}, @pxref{update}.)
4350 If you use @option{--append} to add a file that has the same name as an
4351 archive member to an archive containing that archive member, then the
4352 old member is not deleted. What does happen, however, is somewhat
4353 complex. @command{tar} @emph{allows} you to have infinite number of files
4354 with the same name. Some operations treat these same-named members no
4355 differently than any other set of archive members: for example, if you
4356 view an archive with @option{--list} (@option{-t}), you will see all
4357 of those members listed, with their data modification times, owners, etc.
4359 Other operations don't deal with these members as perfectly as you might
4360 prefer; if you were to use @option{--extract} to extract the archive,
4361 only the most recently added copy of a member with the same name as four
4362 other members would end up in the working directory. This is because
4363 @option{--extract} extracts an archive in the order the members appeared
4364 in the archive; the most recently archived members will be extracted
4365 last. Additionally, an extracted member will @emph{replace} a file of
4366 the same name which existed in the directory already, and @command{tar}
4367 will not prompt you about this@footnote{Unless you give it
4368 @option{--keep-old-files} option, or the disk copy is newer than the
4369 the one in the archive and you invoke @command{tar} with
4370 @option{--keep-newer-files} option}. Thus, only the most recently archived
4371 member will end up being extracted, as it will replace the one
4372 extracted before it, and so on.
4374 @cindex extracting @var{n}th copy of the file
4375 @xopindex{occurrence, described}
4376 There exists a special option that allows you to get around this
4377 behavior and extract (or list) only a particular copy of the file.
4378 This is @option{--occurrence} option. If you run @command{tar} with
4379 this option, it will extract only the first copy of the file. You
4380 may also give this option an argument specifying the number of
4381 copy to be extracted. Thus, for example if the archive
4382 @file{archive.tar} contained three copies of file @file{myfile}, then
4386 tar --extract --file archive.tar --occurrence=2 myfile
4390 would extract only the second copy. @xref{Option
4391 Summary,---occurrence}, for the description of @option{--occurrence}
4394 @FIXME{ hag -- you might want to incorporate some of the above into the
4395 MMwtSN node; not sure. i didn't know how to make it simpler...
4397 There are a few ways to get around this. (maybe xref Multiple Members
4398 with the Same Name.}
4400 @cindex Members, replacing with other members
4401 @cindex Replacing members with other members
4402 @xopindex{delete, using before --append}
4403 If you want to replace an archive member, use @option{--delete} to
4404 delete the member you want to remove from the archive, and then use
4405 @option{--append} to add the member you want to be in the archive. Note
4406 that you can not change the order of the archive; the most recently
4407 added member will still appear last. In this sense, you cannot truly
4408 ``replace'' one member with another. (Replacing one member with another
4409 will not work on certain types of media, such as tapes; see @ref{delete}
4410 and @ref{Media}, for more information.)
4413 * appending files:: Appending Files to an Archive
4417 @node appending files
4418 @subsubsection Appending Files to an Archive
4419 @cindex Adding files to an Archive
4420 @cindex Appending files to an Archive
4421 @cindex Archives, Appending files to
4424 The simplest way to add a file to an already existing archive is the
4425 @option{--append} (@option{-r}) operation, which writes specified
4426 files into the archive whether or not they are already among the
4429 When you use @option{--append}, you @emph{must} specify file name
4430 arguments, as there is no default. If you specify a file that already
4431 exists in the archive, another copy of the file will be added to the
4432 end of the archive. As with other operations, the member names of the
4433 newly added files will be exactly the same as their names given on the
4434 command line. The @option{--verbose} (@option{-v}) option will print
4435 out the names of the files as they are written into the archive.
4437 @option{--append} cannot be performed on some tape drives, unfortunately,
4438 due to deficiencies in the formats those tape drives use. The archive
4439 must be a valid @command{tar} archive, or else the results of using this
4440 operation will be unpredictable. @xref{Media}.
4442 To demonstrate using @option{--append} to add a file to an archive,
4443 create a file called @file{rock} in the @file{practice} directory.
4444 Make sure you are in the @file{practice} directory. Then, run the
4445 following @command{tar} command to add @file{rock} to
4446 @file{collection.tar}:
4449 $ @kbd{tar --append --file=collection.tar rock}
4453 If you now use the @option{--list} (@option{-t}) operation, you will see that
4454 @file{rock} has been added to the archive:
4457 $ @kbd{tar --list --file=collection.tar}
4458 -rw-r--r-- me user 28 1996-10-18 16:31 jazz
4459 -rw-r--r-- me user 21 1996-09-23 16:44 blues
4460 -rw-r--r-- me user 20 1996-09-23 16:44 folk
4461 -rw-r--r-- me user 20 1996-09-23 16:44 rock
4465 @subsubsection Multiple Members with the Same Name
4466 @cindex members, multiple
4467 @cindex multiple members
4469 You can use @option{--append} (@option{-r}) to add copies of files
4470 which have been updated since the archive was created. (However, we
4471 do not recommend doing this since there is another @command{tar}
4472 option called @option{--update}; @xref{update}, for more information.
4473 We describe this use of @option{--append} here for the sake of
4474 completeness.) When you extract the archive, the older version will
4475 be effectively lost. This works because files are extracted from an
4476 archive in the order in which they were archived. Thus, when the
4477 archive is extracted, a file archived later in time will replace a
4478 file of the same name which was archived earlier, even though the
4479 older version of the file will remain in the archive unless you delete
4480 all versions of the file.
4482 Supposing you change the file @file{blues} and then append the changed
4483 version to @file{collection.tar}. As you saw above, the original
4484 @file{blues} is in the archive @file{collection.tar}. If you change the
4485 file and append the new version of the file to the archive, there will
4486 be two copies in the archive. When you extract the archive, the older
4487 version of the file will be extracted first, and then replaced by the
4488 newer version when it is extracted.
4490 You can append the new, changed copy of the file @file{blues} to the
4491 archive in this way:
4494 $ @kbd{tar --append --verbose --file=collection.tar blues}
4499 Because you specified the @option{--verbose} option, @command{tar} has
4500 printed the name of the file being appended as it was acted on. Now
4501 list the contents of the archive:
4504 $ @kbd{tar --list --verbose --file=collection.tar}
4505 -rw-r--r-- me user 28 1996-10-18 16:31 jazz
4506 -rw-r--r-- me user 21 1996-09-23 16:44 blues
4507 -rw-r--r-- me user 20 1996-09-23 16:44 folk
4508 -rw-r--r-- me user 20 1996-09-23 16:44 rock
4509 -rw-r--r-- me user 58 1996-10-24 18:30 blues
4513 The newest version of @file{blues} is now at the end of the archive
4514 (note the different creation dates and file sizes). If you extract
4515 the archive, the older version of the file @file{blues} will be
4516 replaced by the newer version. You can confirm this by extracting
4517 the archive and running @samp{ls} on the directory.
4519 If you wish to extract the first occurrence of the file @file{blues}
4520 from the archive, use @option{--occurrence} option, as shown in
4521 the following example:
4524 $ @kbd{tar --extract -vv --occurrence --file=collection.tar blues}
4525 -rw-r--r-- me user 21 1996-09-23 16:44 blues
4528 @xref{Writing}, for more information on @option{--extract} and
4529 @xref{Option Summary, --occurrence}, for the description of
4530 @option{--occurrence} option.
4533 @subsection Updating an Archive
4534 @cindex Updating an archive
4537 In the previous section, you learned how to use @option{--append} to
4538 add a file to an existing archive. A related operation is
4539 @option{--update} (@option{-u}). The @option{--update} operation
4540 updates a @command{tar} archive by comparing the date of the specified
4541 archive members against the date of the file with the same name. If
4542 the file has been modified more recently than the archive member, then
4543 the newer version of the file is added to the archive (as with
4546 Unfortunately, you cannot use @option{--update} with magnetic tape drives.
4547 The operation will fail.
4549 @FIXME{other examples of media on which --update will fail? need to ask
4550 charles and/or mib/thomas/dave shevett..}
4552 Both @option{--update} and @option{--append} work by adding to the end
4553 of the archive. When you extract a file from the archive, only the
4554 version stored last will wind up in the file system, unless you use
4555 the @option{--backup} option. @xref{multiple}, for a detailed discussion.
4562 @subsubsection How to Update an Archive Using @option{--update}
4565 You must use file name arguments with the @option{--update}
4566 (@option{-u}) operation. If you don't specify any files,
4567 @command{tar} won't act on any files and won't tell you that it didn't
4568 do anything (which may end up confusing you).
4570 @c note: the above parenthetical added because in fact, this
4571 @c behavior just confused the author. :-)
4573 To see the @option{--update} option at work, create a new file,
4574 @file{classical}, in your practice directory, and some extra text to the
4575 file @file{blues}, using any text editor. Then invoke @command{tar} with
4576 the @samp{update} operation and the @option{--verbose} (@option{-v})
4577 option specified, using the names of all the files in the practice
4578 directory as file name arguments:
4581 $ @kbd{tar --update -v -f collection.tar blues folk rock classical}
4588 Because we have specified verbose mode, @command{tar} prints out the names
4589 of the files it is working on, which in this case are the names of the
4590 files that needed to be updated. If you run @samp{tar --list} and look
4591 at the archive, you will see @file{blues} and @file{classical} at its
4592 end. There will be a total of two versions of the member @samp{blues};
4593 the one at the end will be newer and larger, since you added text before
4596 (The reason @command{tar} does not overwrite the older file when updating
4597 it is because writing to the middle of a section of tape is a difficult
4598 process. Tapes are not designed to go backward. @xref{Media}, for more
4599 information about tapes.
4601 @option{--update} (@option{-u}) is not suitable for performing backups for two
4602 reasons: it does not change directory content entries, and it
4603 lengthens the archive every time it is used. The @GNUTAR{}
4604 options intended specifically for backups are more
4605 efficient. If you need to run backups, please consult @ref{Backups}.
4608 @subsection Combining Archives with @option{--concatenate}
4610 @cindex Adding archives to an archive
4611 @cindex Concatenating Archives
4612 @opindex concatenate
4614 @c @cindex @option{-A} described
4615 Sometimes it may be convenient to add a second archive onto the end of
4616 an archive rather than adding individual files to the archive. To add
4617 one or more archives to the end of another archive, you should use the
4618 @option{--concatenate} (@option{--catenate}, @option{-A}) operation.
4620 To use @option{--concatenate}, give the first archive with
4621 @option{--file} option and name the rest of archives to be
4622 concatenated on the command line. The members, and their member
4623 names, will be copied verbatim from those archives to the first one.
4624 @footnote{This can cause multiple members to have the same name, for
4625 information on how this affects reading the archive, @ref{multiple}.}
4626 The new, concatenated archive will be called by the same name as the
4627 one given with the @option{--file} option. As usual, if you omit
4628 @option{--file}, @command{tar} will use the value of the environment
4629 variable @env{TAPE}, or, if this has not been set, the default archive name.
4631 @FIXME{There is no way to specify a new name...}
4633 To demonstrate how @option{--concatenate} works, create two small archives
4634 called @file{bluesrock.tar} and @file{folkjazz.tar}, using the relevant
4635 files from @file{practice}:
4638 $ @kbd{tar -cvf bluesrock.tar blues rock}
4641 $ @kbd{tar -cvf folkjazz.tar folk jazz}
4647 If you like, You can run @samp{tar --list} to make sure the archives
4648 contain what they are supposed to:
4651 $ @kbd{tar -tvf bluesrock.tar}
4652 -rw-r--r-- melissa user 105 1997-01-21 19:42 blues
4653 -rw-r--r-- melissa user 33 1997-01-20 15:34 rock
4654 $ @kbd{tar -tvf jazzfolk.tar}
4655 -rw-r--r-- melissa user 20 1996-09-23 16:44 folk
4656 -rw-r--r-- melissa user 65 1997-01-30 14:15 jazz
4659 We can concatenate these two archives with @command{tar}:
4663 $ @kbd{tar --concatenate --file=bluesrock.tar jazzfolk.tar}
4666 If you now list the contents of the @file{bluesrock.tar}, you will see
4667 that now it also contains the archive members of @file{jazzfolk.tar}:
4670 $ @kbd{tar --list --file=bluesrock.tar}
4677 When you use @option{--concatenate}, the source and target archives must
4678 already exist and must have been created using compatible format
4679 parameters. Notice, that @command{tar} does not check whether the
4680 archives it concatenates have compatible formats, it does not
4681 even check if the files are really tar archives.
4683 Like @option{--append} (@option{-r}), this operation cannot be performed on some
4684 tape drives, due to deficiencies in the formats those tape drives use.
4686 @cindex @code{concatenate} vs @command{cat}
4687 @cindex @command{cat} vs @code{concatenate}
4688 It may seem more intuitive to you to want or try to use @command{cat} to
4689 concatenate two archives instead of using the @option{--concatenate}
4690 operation; after all, @command{cat} is the utility for combining files.
4692 However, @command{tar} archives incorporate an end-of-file marker which
4693 must be removed if the concatenated archives are to be read properly as
4694 one archive. @option{--concatenate} removes the end-of-archive marker
4695 from the target archive before each new archive is appended. If you use
4696 @command{cat} to combine the archives, the result will not be a valid
4697 @command{tar} format archive. If you need to retrieve files from an
4698 archive that was added to using the @command{cat} utility, use the
4699 @option{--ignore-zeros} (@option{-i}) option. @xref{Ignore Zeros}, for further
4700 information on dealing with archives improperly combined using the
4701 @command{cat} shell utility.
4704 @subsection Removing Archive Members Using @option{--delete}
4705 @cindex Deleting files from an archive
4706 @cindex Removing files from an archive
4709 You can remove members from an archive by using the @option{--delete}
4710 option. Specify the name of the archive with @option{--file}
4711 (@option{-f}) and then specify the names of the members to be deleted;
4712 if you list no member names, nothing will be deleted. The
4713 @option{--verbose} option will cause @command{tar} to print the names
4714 of the members as they are deleted. As with @option{--extract}, you
4715 must give the exact member names when using @samp{tar --delete}.
4716 @option{--delete} will remove all versions of the named file from the
4717 archive. The @option{--delete} operation can run very slowly.
4719 Unlike other operations, @option{--delete} has no short form.
4721 @cindex Tapes, using @option{--delete} and
4722 @cindex Deleting from tape archives
4723 This operation will rewrite the archive. You can only use
4724 @option{--delete} on an archive if the archive device allows you to
4725 write to any point on the media, such as a disk; because of this, it
4726 does not work on magnetic tapes. Do not try to delete an archive member
4727 from a magnetic tape; the action will not succeed, and you will be
4728 likely to scramble the archive and damage your tape. There is no safe
4729 way (except by completely re-writing the archive) to delete files from
4730 most kinds of magnetic tape. @xref{Media}.
4732 To delete all versions of the file @file{blues} from the archive
4733 @file{collection.tar} in the @file{practice} directory, make sure you
4734 are in that directory, and then,
4737 $ @kbd{tar --list --file=collection.tar}
4742 $ @kbd{tar --delete --file=collection.tar blues}
4743 $ @kbd{tar --list --file=collection.tar}
4750 @FIXME{Check if the above listing is actually produced after running
4751 all the examples on collection.tar.}
4753 The @option{--delete} option has been reported to work properly when
4754 @command{tar} acts as a filter from @code{stdin} to @code{stdout}.
4757 @subsection Comparing Archive Members with the File System
4758 @cindex Verifying the currency of an archive
4761 The @option{--compare} (@option{-d}), or @option{--diff} operation compares
4762 specified archive members against files with the same names, and then
4763 reports differences in file size, mode, owner, modification date and
4764 contents. You should @emph{only} specify archive member names, not file
4765 names. If you do not name any members, then @command{tar} will compare the
4766 entire archive. If a file is represented in the archive but does not
4767 exist in the file system, @command{tar} reports a difference.
4769 You have to specify the record size of the archive when modifying an
4770 archive with a non-default record size.
4772 @command{tar} ignores files in the file system that do not have
4773 corresponding members in the archive.
4775 The following example compares the archive members @file{rock},
4776 @file{blues} and @file{funk} in the archive @file{bluesrock.tar} with
4777 files of the same name in the file system. (Note that there is no file,
4778 @file{funk}; @command{tar} will report an error message.)
4781 $ @kbd{tar --compare --file=bluesrock.tar rock blues funk}
4784 tar: funk not found in archive
4787 The spirit behind the @option{--compare} (@option{--diff},
4788 @option{-d}) option is to check whether the archive represents the
4789 current state of files on disk, more than validating the integrity of
4790 the archive media. For this later goal, @xref{verify}.
4792 @node create options
4793 @section Options Used by @option{--create}
4795 @xopindex{create, additional options}
4796 The previous chapter described the basics of how to use
4797 @option{--create} (@option{-c}) to create an archive from a set of files.
4798 @xref{create}. This section described advanced options to be used with
4802 * override:: Overriding File Metadata.
4803 * Ignore Failed Read::
4807 @subsection Overriding File Metadata
4809 As described above, a @command{tar} archive keeps, for each member it contains,
4810 its @dfn{metadata}, such as modification time, mode and ownership of
4811 the file. @GNUTAR{} allows to replace these data with other values
4812 when adding files to the archive. The options described in this
4813 section affect creation of archives of any type. For POSIX archives,
4814 see also @ref{PAX keywords}, for additional ways of controlling
4815 metadata, stored in the archive.
4819 @item --mode=@var{permissions}
4821 When adding files to an archive, @command{tar} will use
4822 @var{permissions} for the archive members, rather than the permissions
4823 from the files. @var{permissions} can be specified either as an octal
4824 number or as symbolic permissions, like with
4825 @command{chmod} (@xref{File permissions, Permissions, File
4826 permissions, fileutils, @acronym{GNU} file utilities}. This reference
4827 also has useful information for those not being overly familiar with
4828 the UNIX permission system). Using latter syntax allows for
4829 more flexibility. For example, the value @samp{a+rw} adds read and write
4830 permissions for everybody, while retaining executable bits on directories
4831 or on any other file already marked as executable:
4834 $ @kbd{tar -c -f archive.tar --mode='a+rw' .}
4837 @item --mtime=@var{date}
4840 When adding files to an archive, @command{tar} will use @var{date} as
4841 the modification time of members when creating archives, instead of
4842 their actual modification times. The argument @var{date} can be
4843 either a textual date representation in almost arbitrary format
4844 (@pxref{Date input formats}) or a name of the existing file, starting
4845 with @samp{/} or @samp{.}. In the latter case, the modification time
4846 of that file will be used.
4848 The following example will set the modification date to 00:00:00 UTC,
4852 $ @kbd{tar -c -f archive.tar --mtime='1970-01-01' .}
4856 When used with @option{--verbose} (@pxref{verbose tutorial}) @GNUTAR{}
4857 will try to convert the specified date back to its textual
4858 representation and compare it with the one given with
4859 @option{--mtime} options. If the two dates differ, @command{tar} will
4860 print a warning saying what date it will use. This is to help user
4861 ensure he is using the right date.
4866 $ @kbd{tar -c -f archive.tar -v --mtime=yesterday .}
4867 tar: Option --mtime: Treating date `yesterday' as 2006-06-20
4872 @item --owner=@var{user}
4875 Specifies that @command{tar} should use @var{user} as the owner of members
4876 when creating archives, instead of the user associated with the source
4877 file. The argument @var{user} can be either an existing user symbolic
4878 name, or a decimal numeric user @acronym{ID}.
4880 There is no value indicating a missing number, and @samp{0} usually means
4881 @code{root}. Some people like to force @samp{0} as the value to offer in
4882 their distributions for the owner of files, because the @code{root} user is
4883 anonymous anyway, so that might as well be the owner of anonymous
4884 archives. For example:
4888 $ @kbd{tar -c -f archive.tar --owner=0 .}
4890 $ @kbd{tar -c -f archive.tar --owner=root .}
4894 @item --group=@var{group}
4897 Files added to the @command{tar} archive will have a group @acronym{ID} of @var{group},
4898 rather than the group from the source file. The argument @var{group}
4899 can be either an existing group symbolic name, or a decimal numeric group @acronym{ID}.
4902 @node Ignore Failed Read
4903 @subsection Ignore Fail Read
4906 @item --ignore-failed-read
4907 @opindex ignore-failed-read
4908 Do not exit with nonzero on unreadable files or directories.
4911 @node extract options
4912 @section Options Used by @option{--extract}
4913 @cindex options for use with @option{--extract}
4915 @xopindex{extract, additional options}
4916 The previous chapter showed how to use @option{--extract} to extract
4917 an archive into the file system. Various options cause @command{tar} to
4918 extract more information than just file contents, such as the owner,
4919 the permissions, the modification date, and so forth. This section
4920 presents options to be used with @option{--extract} when certain special
4921 considerations arise. You may review the information presented in
4922 @ref{extract} for more basic information about the
4923 @option{--extract} operation.
4926 * Reading:: Options to Help Read Archives
4927 * Writing:: Changing How @command{tar} Writes Files
4928 * Scarce:: Coping with Scarce Resources
4932 @subsection Options to Help Read Archives
4933 @cindex Options when reading archives
4935 @cindex Reading incomplete records
4936 @cindex Records, incomplete
4937 @opindex read-full-records
4938 Normally, @command{tar} will request data in full record increments from
4939 an archive storage device. If the device cannot return a full record,
4940 @command{tar} will report an error. However, some devices do not always
4941 return full records, or do not require the last record of an archive to
4942 be padded out to the next record boundary. To keep reading until you
4943 obtain a full record, or to accept an incomplete record if it contains
4944 an end-of-archive marker, specify the @option{--read-full-records} (@option{-B}) option
4945 in conjunction with the @option{--extract} or @option{--list} operations.
4948 The @option{--read-full-records} (@option{-B}) option is turned on by default when
4949 @command{tar} reads an archive from standard input, or from a remote
4950 machine. This is because on @acronym{BSD} Unix systems, attempting to read a
4951 pipe returns however much happens to be in the pipe, even if it is
4952 less than was requested. If this option were not enabled, @command{tar}
4953 would fail as soon as it read an incomplete record from the pipe.
4955 If you're not sure of the blocking factor of an archive, you can
4956 read the archive by specifying @option{--read-full-records} (@option{-B}) and
4957 @option{--blocking-factor=@var{512-size}} (@option{-b
4958 @var{512-size}}), using a blocking factor larger than what the archive
4959 uses. This lets you avoid having to determine the blocking factor
4960 of an archive. @xref{Blocking Factor}.
4963 * read full records::
4967 @node read full records
4968 @unnumberedsubsubsec Reading Full Records
4970 @FIXME{need sentence or so of intro here}
4973 @opindex read-full-records
4974 @item --read-full-records
4976 Use in conjunction with @option{--extract} (@option{--get},
4977 @option{-x}) to read an archive which contains incomplete records, or
4978 one which has a blocking factor less than the one specified.
4982 @unnumberedsubsubsec Ignoring Blocks of Zeros
4984 @cindex End-of-archive blocks, ignoring
4985 @cindex Ignoring end-of-archive blocks
4986 @opindex ignore-zeros
4987 Normally, @command{tar} stops reading when it encounters a block of zeros
4988 between file entries (which usually indicates the end of the archive).
4989 @option{--ignore-zeros} (@option{-i}) allows @command{tar} to
4990 completely read an archive which contains a block of zeros before the
4991 end (i.e., a damaged archive, or one that was created by concatenating
4992 several archives together).
4994 The @option{--ignore-zeros} (@option{-i}) option is turned off by default because many
4995 versions of @command{tar} write garbage after the end-of-archive entry,
4996 since that part of the media is never supposed to be read. @GNUTAR{}
4997 does not write after the end of an archive, but seeks to
4998 maintain compatibility among archiving utilities.
5001 @item --ignore-zeros
5003 To ignore blocks of zeros (i.e., end-of-archive entries) which may be
5004 encountered while reading an archive. Use in conjunction with
5005 @option{--extract} or @option{--list}.
5009 @subsection Changing How @command{tar} Writes Files
5012 @FIXME{Introductory paragraph}
5015 * Dealing with Old Files::
5016 * Overwrite Old Files::
5018 * Keep Newer Files::
5020 * Recursive Unlink::
5021 * Data Modification Times::
5022 * Setting Access Permissions::
5023 * Directory Modification Times and Permissions::
5024 * Writing to Standard Output::
5025 * Writing to an External Program::
5029 @node Dealing with Old Files
5030 @unnumberedsubsubsec Options Controlling the Overwriting of Existing Files
5032 @xopindex{overwrite-dir, introduced}
5033 When extracting files, if @command{tar} discovers that the extracted
5034 file already exists, it normally replaces the file by removing it before
5035 extracting it, to prevent confusion in the presence of hard or symbolic
5036 links. (If the existing file is a symbolic link, it is removed, not
5037 followed.) However, if a directory cannot be removed because it is
5038 nonempty, @command{tar} normally overwrites its metadata (ownership,
5039 permission, etc.). The @option{--overwrite-dir} option enables this
5040 default behavior. To be more cautious and preserve the metadata of
5041 such a directory, use the @option{--no-overwrite-dir} option.
5043 @cindex Overwriting old files, prevention
5044 @xopindex{keep-old-files, introduced}
5045 To be even more cautious and prevent existing files from being replaced, use
5046 the @option{--keep-old-files} (@option{-k}) option. It causes @command{tar} to refuse
5047 to replace or update a file that already exists, i.e., a file with the
5048 same name as an archive member prevents extraction of that archive
5049 member. Instead, it reports an error.
5051 @xopindex{overwrite, introduced}
5052 To be more aggressive about altering existing files, use the
5053 @option{--overwrite} option. It causes @command{tar} to overwrite
5054 existing files and to follow existing symbolic links when extracting.
5056 @cindex Protecting old files
5057 Some people argue that @GNUTAR{} should not hesitate
5058 to overwrite files with other files when extracting. When extracting
5059 a @command{tar} archive, they expect to see a faithful copy of the
5060 state of the file system when the archive was created. It is debatable
5061 that this would always be a proper behavior. For example, suppose one
5062 has an archive in which @file{usr/local} is a link to
5063 @file{usr/local2}. Since then, maybe the site removed the link and
5064 renamed the whole hierarchy from @file{/usr/local2} to
5065 @file{/usr/local}. Such things happen all the time. I guess it would
5066 not be welcome at all that @GNUTAR{} removes the
5067 whole hierarchy just to make room for the link to be reinstated
5068 (unless it @emph{also} simultaneously restores the full
5069 @file{/usr/local2}, of course!) @GNUTAR{} is indeed
5070 able to remove a whole hierarchy to reestablish a symbolic link, for
5071 example, but @emph{only if} @option{--recursive-unlink} is specified
5072 to allow this behavior. In any case, single files are silently
5075 @xopindex{unlink-first, introduced}
5076 Finally, the @option{--unlink-first} (@option{-U}) option can improve performance in
5077 some cases by causing @command{tar} to remove files unconditionally
5078 before extracting them.
5080 @node Overwrite Old Files
5081 @unnumberedsubsubsec Overwrite Old Files
5086 Overwrite existing files and directory metadata when extracting files
5089 This causes @command{tar} to write extracted files into the file system without
5090 regard to the files already on the system; i.e., files with the same
5091 names as archive members are overwritten when the archive is extracted.
5092 It also causes @command{tar} to extract the ownership, permissions,
5093 and time stamps onto any preexisting files or directories.
5094 If the name of a corresponding file name is a symbolic link, the file
5095 pointed to by the symbolic link will be overwritten instead of the
5096 symbolic link itself (if this is possible). Moreover, special devices,
5097 empty directories and even symbolic links are automatically removed if
5098 they are in the way of extraction.
5100 Be careful when using the @option{--overwrite} option, particularly when
5101 combined with the @option{--absolute-names} (@option{-P}) option, as this combination
5102 can change the contents, ownership or permissions of any file on your
5103 system. Also, many systems do not take kindly to overwriting files that
5104 are currently being executed.
5106 @opindex overwrite-dir
5107 @item --overwrite-dir
5108 Overwrite the metadata of directories when extracting files from an
5109 archive, but remove other files before extracting.
5112 @node Keep Old Files
5113 @unnumberedsubsubsec Keep Old Files
5116 @opindex keep-old-files
5117 @item --keep-old-files
5119 Do not replace existing files from archive. The
5120 @option{--keep-old-files} (@option{-k}) option prevents @command{tar}
5121 from replacing existing files with files with the same name from the
5122 archive. The @option{--keep-old-files} option is meaningless with
5123 @option{--list} (@option{-t}). Prevents @command{tar} from replacing
5124 files in the file system during extraction.
5127 @node Keep Newer Files
5128 @unnumberedsubsubsec Keep Newer Files
5131 @opindex keep-newer-files
5132 @item --keep-newer-files
5133 Do not replace existing files that are newer than their archive
5134 copies. This option is meaningless with @option{--list} (@option{-t}).
5138 @unnumberedsubsubsec Unlink First
5141 @opindex unlink-first
5142 @item --unlink-first
5144 Remove files before extracting over them.
5145 This can make @command{tar} run a bit faster if you know in advance
5146 that the extracted files all need to be removed. Normally this option
5147 slows @command{tar} down slightly, so it is disabled by default.
5150 @node Recursive Unlink
5151 @unnumberedsubsubsec Recursive Unlink
5154 @opindex recursive-unlink
5155 @item --recursive-unlink
5156 When this option is specified, try removing files and directory hierarchies
5157 before extracting over them. @emph{This is a dangerous option!}
5160 If you specify the @option{--recursive-unlink} option,
5161 @command{tar} removes @emph{anything} that keeps you from extracting a file
5162 as far as current permissions will allow it. This could include removal
5163 of the contents of a full directory hierarchy.
5165 @node Data Modification Times
5166 @unnumberedsubsubsec Setting Data Modification Times
5168 @cindex Data modification times of extracted files
5169 @cindex Modification times of extracted files
5170 Normally, @command{tar} sets the data modification times of extracted
5171 files to the corresponding times recorded for the files in the archive, but
5172 limits the permissions of extracted files by the current @code{umask}
5175 To set the data modification times of extracted files to the time when
5176 the files were extracted, use the @option{--touch} (@option{-m}) option in
5177 conjunction with @option{--extract} (@option{--get}, @option{-x}).
5183 Sets the data modification time of extracted archive members to the time
5184 they were extracted, not the time recorded for them in the archive.
5185 Use in conjunction with @option{--extract} (@option{--get}, @option{-x}).
5188 @node Setting Access Permissions
5189 @unnumberedsubsubsec Setting Access Permissions
5191 @cindex Permissions of extracted files
5192 @cindex Modes of extracted files
5193 To set the modes (access permissions) of extracted files to those
5194 recorded for those files in the archive, use @option{--same-permissions}
5195 in conjunction with the @option{--extract} (@option{--get},
5196 @option{-x}) operation.
5199 @opindex preserve-permissions
5200 @opindex same-permissions
5201 @item --preserve-permissions
5202 @itemx --same-permissions
5203 @c @itemx --ignore-umask
5205 Set modes of extracted archive members to those recorded in the
5206 archive, instead of current umask settings. Use in conjunction with
5207 @option{--extract} (@option{--get}, @option{-x}).
5210 @node Directory Modification Times and Permissions
5211 @unnumberedsubsubsec Directory Modification Times and Permissions
5213 After successfully extracting a file member, @GNUTAR{} normally
5214 restores its permissions and modification times, as described in the
5215 previous sections. This cannot be done for directories, because
5216 after extracting a directory @command{tar} will almost certainly
5217 extract files into that directory and this will cause the directory
5218 modification time to be updated. Moreover, restoring that directory
5219 permissions may not permit file creation within it. Thus, restoring
5220 directory permissions and modification times must be delayed at least
5221 until all files have been extracted into that directory. @GNUTAR{}
5222 restores directories using the following approach.
5224 The extracted directories are created with the mode specified in the
5225 archive, as modified by the umask of the user, which gives sufficient
5226 permissions to allow file creation. The meta-information about the
5227 directory is recorded in the temporary list of directories. When
5228 preparing to extract next archive member, @GNUTAR{} checks if the
5229 directory prefix of this file contains the remembered directory. If
5230 it does not, the program assumes that all files have been extracted
5231 into that directory, restores its modification time and permissions
5232 and removes its entry from the internal list. This approach allows
5233 to correctly restore directory meta-information in the majority of
5234 cases, while keeping memory requirements sufficiently small. It is
5235 based on the fact, that most @command{tar} archives use the predefined
5236 order of members: first the directory, then all the files and
5237 subdirectories in that directory.
5239 However, this is not always true. The most important exception are
5240 incremental archives (@pxref{Incremental Dumps}). The member order in
5241 an incremental archive is reversed: first all directory members are
5242 stored, followed by other (non-directory) members. So, when extracting
5243 from incremental archives, @GNUTAR{} alters the above procedure. It
5244 remembers all restored directories, and restores their meta-data
5245 only after the entire archive has been processed. Notice, that you do
5246 not need to specify any special options for that, as @GNUTAR{}
5247 automatically detects archives in incremental format.
5249 There may be cases, when such processing is required for normal archives
5250 too. Consider the following example:
5254 $ @kbd{tar --no-recursion -cvf archive \
5255 foo foo/file1 bar bar/file foo/file2}
5264 During the normal operation, after encountering @file{bar}
5265 @GNUTAR{} will assume that all files from the directory @file{foo}
5266 were already extracted and will therefore restore its timestamp and
5267 permission bits. However, after extracting @file{foo/file2} the
5268 directory timestamp will be offset again.
5270 To correctly restore directory meta-information in such cases, use
5271 @option{delay-directory-restore} command line option:
5274 @opindex delay-directory-restore
5275 @item --delay-directory-restore
5276 Delays restoring of the modification times and permissions of extracted
5277 directories until the end of extraction. This way, correct
5278 meta-information is restored even if the archive has unusual member
5281 @opindex no-delay-directory-restore
5282 @item --no-delay-directory-restore
5283 Cancel the effect of the previous @option{--delay-directory-restore}.
5284 Use this option if you have used @option{--delay-directory-restore} in
5285 @env{TAR_OPTIONS} variable (@pxref{TAR_OPTIONS}) and wish to
5286 temporarily disable it.
5289 @node Writing to Standard Output
5290 @unnumberedsubsubsec Writing to Standard Output
5292 @cindex Writing extracted files to standard output
5293 @cindex Standard output, writing extracted files to
5294 To write the extracted files to the standard output, instead of
5295 creating the files on the file system, use @option{--to-stdout} (@option{-O}) in
5296 conjunction with @option{--extract} (@option{--get}, @option{-x}). This option is useful if you are
5297 extracting files to send them through a pipe, and do not need to
5298 preserve them in the file system. If you extract multiple members,
5299 they appear on standard output concatenated, in the order they are
5300 found in the archive.
5306 Writes files to the standard output. Use only in conjunction with
5307 @option{--extract} (@option{--get}, @option{-x}). When this option is
5308 used, instead of creating the files specified, @command{tar} writes
5309 the contents of the files extracted to its standard output. This may
5310 be useful if you are only extracting the files in order to send them
5311 through a pipe. This option is meaningless with @option{--list}
5315 This can be useful, for example, if you have a tar archive containing
5316 a big file and don't want to store the file on disk before processing
5317 it. You can use a command like this:
5320 tar -xOzf foo.tgz bigfile | process
5323 or even like this if you want to process the concatenation of the files:
5326 tar -xOzf foo.tgz bigfile1 bigfile2 | process
5329 However, @option{--to-command} may be more convenient for use with
5330 multiple files. See the next section.
5332 @node Writing to an External Program
5333 @unnumberedsubsubsec Writing to an External Program
5335 You can instruct @command{tar} to send the contents of each extracted
5336 file to the standard input of an external program:
5340 @item --to-command=@var{command}
5341 Extract files and pipe their contents to the standard input of
5342 @var{command}. When this option is used, instead of creating the
5343 files specified, @command{tar} invokes @var{command} and pipes the
5344 contents of the files to its standard output. @var{Command} may
5345 contain command line arguments. The program is executed via
5346 @code{sh -c}. Notice, that @var{command} is executed once for each regular file
5347 extracted. Non-regular files (directories, etc.) are ignored when this
5351 The command can obtain the information about the file it processes
5352 from the following environment variables:
5355 @vrindex TAR_FILETYPE, to-command environment
5357 Type of the file. It is a single letter with the following meaning:
5359 @multitable @columnfractions 0.10 0.90
5360 @item f @tab Regular file
5361 @item d @tab Directory
5362 @item l @tab Symbolic link
5363 @item h @tab Hard link
5364 @item b @tab Block device
5365 @item c @tab Character device
5368 Currently only regular files are supported.
5370 @vrindex TAR_MODE, to-command environment
5372 File mode, an octal number.
5374 @vrindex TAR_FILENAME, to-command environment
5376 The name of the file.
5378 @vrindex TAR_REALNAME, to-command environment
5380 Name of the file as stored in the archive.
5382 @vrindex TAR_UNAME, to-command environment
5384 Name of the file owner.
5386 @vrindex TAR_GNAME, to-command environment
5388 Name of the file owner group.
5390 @vrindex TAR_ATIME, to-command environment
5392 Time of last access. It is a decimal number, representing seconds
5393 since the epoch. If the archive provides times with nanosecond
5394 precision, the nanoseconds are appended to the timestamp after a
5397 @vrindex TAR_MTIME, to-command environment
5399 Time of last modification.
5401 @vrindex TAR_CTIME, to-command environment
5403 Time of last status change.
5405 @vrindex TAR_SIZE, to-command environment
5409 @vrindex TAR_UID, to-command environment
5411 UID of the file owner.
5413 @vrindex TAR_GID, to-command environment
5415 GID of the file owner.
5418 In addition to these variables, @env{TAR_VERSION} contains the
5419 @GNUTAR{} version number.
5421 If @var{command} exits with a non-0 status, @command{tar} will print
5422 an error message similar to the following:
5425 tar: 2345: Child returned status 1
5428 Here, @samp{2345} is the PID of the finished process.
5430 If this behavior is not wanted, use @option{--ignore-command-error}:
5433 @opindex ignore-command-error
5434 @item --ignore-command-error
5435 Ignore exit codes of subprocesses. Notice that if the program
5436 exits on signal or otherwise terminates abnormally, the error message
5437 will be printed even if this option is used.
5439 @opindex no-ignore-command-error
5440 @item --no-ignore-command-error
5441 Cancel the effect of any previous @option{--ignore-command-error}
5442 option. This option is useful if you have set
5443 @option{--ignore-command-error} in @env{TAR_OPTIONS}
5444 (@pxref{TAR_OPTIONS}) and wish to temporarily cancel it.
5448 @unnumberedsubsubsec Removing Files
5450 @FIXME{The section is too terse. Something more to add? An example,
5454 @opindex remove-files
5455 @item --remove-files
5456 Remove files after adding them to the archive.
5460 @subsection Coping with Scarce Resources
5463 @cindex Small memory
5464 @cindex Running out of space
5472 @unnumberedsubsubsec Starting File
5475 @opindex starting-file
5476 @item --starting-file=@var{name}
5477 @itemx -K @var{name}
5478 Starts an operation in the middle of an archive. Use in conjunction
5479 with @option{--extract} (@option{--get}, @option{-x}) or @option{--list} (@option{-t}).
5482 @cindex Middle of the archive, starting in the
5483 If a previous attempt to extract files failed due to lack of disk
5484 space, you can use @option{--starting-file=@var{name}} (@option{-K
5485 @var{name}}) to start extracting only after member @var{name} of the
5486 archive. This assumes, of course, that there is now free space, or
5487 that you are now extracting into a different file system. (You could
5488 also choose to suspend @command{tar}, remove unnecessary files from
5489 the file system, and then restart the same @command{tar} operation.
5490 In this case, @option{--starting-file} is not necessary.
5491 @xref{Incremental Dumps}, @xref{interactive}, and @ref{exclude}.)
5494 @unnumberedsubsubsec Same Order
5497 @cindex Large lists of file names on small machines
5499 @opindex preserve-order
5501 @itemx --preserve-order
5503 To process large lists of file names on machines with small amounts of
5504 memory. Use in conjunction with @option{--compare} (@option{--diff},
5505 @option{-d}), @option{--list} (@option{-t}) or @option{--extract}
5506 (@option{--get}, @option{-x}).
5509 The @option{--same-order} (@option{--preserve-order}, @option{-s}) option tells @command{tar} that the list of file
5510 names to be listed or extracted is sorted in the same order as the
5511 files in the archive. This allows a large list of names to be used,
5512 even on a small machine that would not otherwise be able to hold all
5513 the names in memory at the same time. Such a sorted list can easily be
5514 created by running @samp{tar -t} on the archive and editing its output.
5516 This option is probably never needed on modern computer systems.
5519 @section Backup options
5521 @cindex backup options
5523 @GNUTAR{} offers options for making backups of files
5524 before writing new versions. These options control the details of
5525 these backups. They may apply to the archive itself before it is
5526 created or rewritten, as well as individual extracted members. Other
5527 @acronym{GNU} programs (@command{cp}, @command{install}, @command{ln},
5528 and @command{mv}, for example) offer similar options.
5530 Backup options may prove unexpectedly useful when extracting archives
5531 containing many members having identical name, or when extracting archives
5532 on systems having file name limitations, making different members appear
5533 as having similar names through the side-effect of name truncation.
5534 @FIXME{This is true only if we have a good scheme for truncated backup names,
5535 which I'm not sure at all: I suspect work is needed in this area.}
5536 When any existing file is backed up before being overwritten by extraction,
5537 then clashing files are automatically be renamed to be unique, and the
5538 true name is kept for only the last file of a series of clashing files.
5539 By using verbose mode, users may track exactly what happens.
5541 At the detail level, some decisions are still experimental, and may
5542 change in the future, we are waiting comments from our users. So, please
5543 do not learn to depend blindly on the details of the backup features.
5544 For example, currently, directories themselves are never renamed through
5545 using these options, so, extracting a file over a directory still has
5546 good chances to fail. Also, backup options apply to created archives,
5547 not only to extracted members. For created archives, backups will not
5548 be attempted when the archive is a block or character device, or when it
5549 refers to a remote file.
5551 For the sake of simplicity and efficiency, backups are made by renaming old
5552 files prior to creation or extraction, and not by copying. The original
5553 name is restored if the file creation fails. If a failure occurs after a
5554 partial extraction of a file, both the backup and the partially extracted
5558 @item --backup[=@var{method}]
5560 @vindex VERSION_CONTROL
5562 Back up files that are about to be overwritten or removed.
5563 Without this option, the original versions are destroyed.
5565 Use @var{method} to determine the type of backups made.
5566 If @var{method} is not specified, use the value of the @env{VERSION_CONTROL}
5567 environment variable. And if @env{VERSION_CONTROL} is not set,
5568 use the @samp{existing} method.
5570 @vindex version-control @r{Emacs variable}
5571 This option corresponds to the Emacs variable @samp{version-control};
5572 the same values for @var{method} are accepted as in Emacs. This option
5573 also allows more descriptive names. The valid @var{method}s are:
5578 @cindex numbered @r{backup method}
5579 Always make numbered backups.
5583 @cindex existing @r{backup method}
5584 Make numbered backups of files that already have them, simple backups
5589 @cindex simple @r{backup method}
5590 Always make simple backups.
5594 @item --suffix=@var{suffix}
5596 @cindex backup suffix
5597 @vindex SIMPLE_BACKUP_SUFFIX
5598 Append @var{suffix} to each backup file made with @option{--backup}. If this
5599 option is not specified, the value of the @env{SIMPLE_BACKUP_SUFFIX}
5600 environment variable is used. And if @env{SIMPLE_BACKUP_SUFFIX} is not
5601 set, the default is @samp{~}, just as in Emacs.
5606 @section Notable @command{tar} Usages
5609 @FIXME{Using Unix file linking capability to recreate directory
5610 structures---linking files into one subdirectory and then
5611 @command{tar}ring that directory.}
5613 @FIXME{Nice hairy example using absolute-names, newer, etc.}
5616 You can easily use archive files to transport a group of files from
5617 one system to another: put all relevant files into an archive on one
5618 computer system, transfer the archive to another system, and extract
5619 the contents there. The basic transfer medium might be magnetic tape,
5620 Internet FTP, or even electronic mail (though you must encode the
5621 archive with @command{uuencode} in order to transport it properly by
5622 mail). Both machines do not have to use the same operating system, as
5623 long as they both support the @command{tar} program.
5625 For example, here is how you might copy a directory's contents from
5626 one disk to another, while preserving the dates, modes, owners and
5627 link-structure of all the files therein. In this case, the transfer
5628 medium is a @dfn{pipe}, which is one a Unix redirection mechanism:
5631 $ @kbd{(cd sourcedir; tar -cf - .) | (cd targetdir; tar -xf -)}
5635 You can avoid subshells by using @option{-C} option:
5638 $ @kbd{tar -C sourcedir -cf - . | tar -C targetdir -xf -}
5642 The command also works using short option forms:
5645 $ @kbd{(cd sourcedir; tar --create --file=- . ) \
5646 | (cd targetdir; tar --extract --file=-)}
5648 $ @kbd{tar --directory sourcedir --create --file=- . ) \
5649 | tar --directory targetdir --extract --file=-}
5653 This is one of the easiest methods to transfer a @command{tar} archive.
5656 @section Looking Ahead: The Rest of this Manual
5658 You have now seen how to use all eight of the operations available to
5659 @command{tar}, and a number of the possible options. The next chapter
5660 explains how to choose and change file and archive names, how to use
5661 files to store names of other files which you can then call as
5662 arguments to @command{tar} (this can help you save time if you expect to
5663 archive the same list of files a number of times), and so forth.
5664 @FIXME{in case it's not obvious, i'm making this up in some sense
5665 based on my limited memory of what the next chapter *really* does. i
5666 just wanted to flesh out this final section a little bit so i'd
5667 remember to stick it in here. :-)}
5669 If there are too many files to conveniently list on the command line,
5670 you can list the names in a file, and @command{tar} will read that file.
5673 There are various ways of causing @command{tar} to skip over some files,
5674 and not archive them. @xref{Choosing}.
5677 @chapter Performing Backups and Restoring Files
5680 @GNUTAR{} is distributed along with the scripts for performing backups
5681 and restores. Even if there is a good chance those scripts may be
5682 satisfying to you, they are not the only scripts or methods available for doing
5683 backups and restore. You may well create your own, or use more
5684 sophisticated packages dedicated to that purpose.
5686 Some users are enthusiastic about @code{Amanda} (The Advanced Maryland
5687 Automatic Network Disk Archiver), a backup system developed by James
5688 da Silva @file{jds@@cs.umd.edu} and available on many Unix systems.
5689 This is free software, and it is available from @uref{http://www.amanda.org}.
5693 Here is a possible plan for a future documentation about the backuping
5694 scripts which are provided within the @GNUTAR{}
5700 @item what are dumps
5701 @item different levels of dumps
5703 @item full dump = dump everything
5704 @item level 1, level 2 dumps etc
5705 A level @var{n} dump dumps everything changed since the last level
5708 @item how to use scripts for dumps (ie, the concept)
5710 @item scripts to run after editing backup specs (details)
5712 @item Backup Specs, what is it.
5714 @item how to customize
5715 @item actual text of script [/sp/dump/backup-specs]
5719 @item rsh doesn't work
5720 @item rtape isn't installed
5723 @item the @option{--incremental} option of tar
5726 @item write protection
5727 @item types of media, different sizes and types, useful for different things
5728 @item files and tape marks
5729 one tape mark between files, two at end.
5730 @item positioning the tape
5731 MT writes two at end of write,
5732 backspaces over one when writing again.
5738 This chapter documents both the provided shell scripts and @command{tar}
5739 options which are more specific to usage as a backup tool.
5741 To @dfn{back up} a file system means to create archives that contain
5742 all the files in that file system. Those archives can then be used to
5743 restore any or all of those files (for instance if a disk crashes or a
5744 file is accidentally deleted). File system @dfn{backups} are also
5748 * Full Dumps:: Using @command{tar} to Perform Full Dumps
5749 * Incremental Dumps:: Using @command{tar} to Perform Incremental Dumps
5750 * Backup Levels:: Levels of Backups
5751 * Backup Parameters:: Setting Parameters for Backups and Restoration
5752 * Scripted Backups:: Using the Backup Scripts
5753 * Scripted Restoration:: Using the Restore Script
5757 @section Using @command{tar} to Perform Full Dumps
5763 @cindex corrupted archives
5764 Full dumps should only be made when no other people or programs
5765 are modifying files in the file system. If files are modified while
5766 @command{tar} is making the backup, they may not be stored properly in
5767 the archive, in which case you won't be able to restore them if you
5768 have to. (Files not being modified are written with no trouble, and do
5769 not corrupt the entire archive.)
5771 You will want to use the @option{--label=@var{archive-label}}
5772 (@option{-V @var{archive-label}}) option to give the archive a
5773 volume label, so you can tell what this archive is even if the label
5774 falls off the tape, or anything like that.
5776 Unless the file system you are dumping is guaranteed to fit on
5777 one volume, you will need to use the @option{--multi-volume} (@option{-M}) option.
5778 Make sure you have enough tapes on hand to complete the backup.
5780 If you want to dump each file system separately you will need to use
5781 the @option{--one-file-system} option to prevent
5782 @command{tar} from crossing file system boundaries when storing
5785 The @option{--incremental} (@option{-G}) (@pxref{Incremental Dumps})
5786 option is not needed, since this is a complete copy of everything in
5787 the file system, and a full restore from this backup would only be
5788 done onto a completely
5791 Unless you are in a hurry, and trust the @command{tar} program (and your
5792 tapes), it is a good idea to use the @option{--verify} (@option{-W})
5793 option, to make sure your files really made it onto the dump properly.
5794 This will also detect cases where the file was modified while (or just
5795 after) it was being archived. Not all media (notably cartridge tapes)
5796 are capable of being verified, unfortunately.
5798 @node Incremental Dumps
5799 @section Using @command{tar} to Perform Incremental Dumps
5801 @dfn{Incremental backup} is a special form of @GNUTAR{} archive that
5802 stores additional metadata so that exact state of the file system
5803 can be restored when extracting the archive.
5805 @GNUTAR{} currently offers two options for handling incremental
5806 backups: @option{--listed-incremental=@var{snapshot-file}} (@option{-g
5807 @var{snapshot-file}}) and @option{--incremental} (@option{-G}).
5809 @xopindex{listed-incremental, described}
5810 The option @option{--listed-incremental} instructs tar to operate on
5811 an incremental archive with additional metadata stored in a standalone
5812 file, called a @dfn{snapshot file}. The purpose of this file is to help
5813 determine which files have been changed, added or deleted since the
5814 last backup, so that the next incremental backup will contain only
5815 modified files. The name of the snapshot file is given as an argument
5819 @item --listed-incremental=@var{file}
5820 @itemx -g @var{file}
5821 Handle incremental backups with snapshot data in @var{file}.
5824 To create an incremental backup, you would use
5825 @option{--listed-incremental} together with @option{--create}
5826 (@pxref{create}). For example:
5829 $ @kbd{tar --create \
5830 --file=archive.1.tar \
5831 --listed-incremental=/var/log/usr.snar \
5835 This will create in @file{archive.1.tar} an incremental backup of
5836 the @file{/usr} file system, storing additional metadata in the file
5837 @file{/var/log/usr.snar}. If this file does not exist, it will be
5838 created. The created archive will then be a @dfn{level 0 backup};
5839 please see the next section for more on backup levels.
5841 Otherwise, if the file @file{/var/log/usr.snar} exists, it
5842 determines which files are modified. In this case only these files will be
5843 stored in the archive. Suppose, for example, that after running the
5844 above command, you delete file @file{/usr/doc/old} and create
5845 directory @file{/usr/local/db} with the following contents:
5848 $ @kbd{ls /usr/local/db}
5853 Some time later you create another incremental backup. You will
5857 $ @kbd{tar --create \
5858 --file=archive.2.tar \
5859 --listed-incremental=/var/log/usr.snar \
5861 tar: usr/local/db: Directory is new
5868 The created archive @file{archive.2.tar} will contain only these
5869 three members. This archive is called a @dfn{level 1 backup}. Notice
5870 that @file{/var/log/usr.snar} will be updated with the new data, so if
5871 you plan to create more @samp{level 1} backups, it is necessary to
5872 create a working copy of the snapshot file before running
5873 @command{tar}. The above example will then be modified as follows:
5876 $ @kbd{cp /var/log/usr.snar /var/log/usr.snar-1}
5877 $ @kbd{tar --create \
5878 --file=archive.2.tar \
5879 --listed-incremental=/var/log/usr.snar-1 \
5884 @xopindex{level, described}
5885 You can force @samp{level 0} backups either by removing the snapshot
5886 file before running @command{tar}, or by supplying the
5887 @option{--level=0} option, e.g.:
5890 $ @kbd{tar --create \
5891 --file=archive.2.tar \
5892 --listed-incremental=/var/log/usr.snar-0 \
5897 Incremental dumps depend crucially on time stamps, so the results are
5898 unreliable if you modify a file's time stamps during dumping (e.g.,
5899 with the @option{--atime-preserve=replace} option), or if you set the clock
5902 @anchor{device numbers}
5903 @cindex Device numbers, using in incremental backups
5904 Metadata stored in snapshot files include device numbers, which,
5905 obviously are supposed to be a non-volatile values. However, it turns
5906 out that @acronym{NFS} devices have undependable values when an automounter
5907 gets in the picture. This can lead to a great deal of spurious
5908 redumping in incremental dumps, so it is somewhat useless to compare
5909 two @acronym{NFS} devices numbers over time. The solution implemented
5910 currently is to considers all @acronym{NFS} devices as being equal
5911 when it comes to comparing directories; this is fairly gross, but
5912 there does not seem to be a better way to go.
5914 Apart from using @acronym{NFS}, there are a number of cases where
5915 relying on device numbers can cause spurious redumping of unmodified
5916 files. For example, this occurs when archiving @acronym{LVM} snapshot
5917 volumes. To avoid this, use @option{--no-check-device} option:
5920 @xopindex{no-check-device, described}
5921 @item --no-check-device
5922 Do not rely on device numbers when preparing a list of changed files
5923 for an incremental dump.
5925 @xopindex{check-device, described}
5926 @item --check-device
5927 Use device numbers when preparing a list of changed files
5928 for an incremental dump. This is the default behavior. The purpose
5929 of this option is to undo the effect of the @option{--no-check-device}
5930 if it was given in @env{TAR_OPTIONS} environment variable
5931 (@pxref{TAR_OPTIONS}).
5934 There is also another way to cope with changing device numbers. It is
5935 described in detail in @ref{Fixing Snapshot Files}.
5937 Note that incremental archives use @command{tar} extensions and may
5938 not be readable by non-@acronym{GNU} versions of the @command{tar} program.
5940 @xopindex{listed-incremental, using with @option{--extract}}
5941 @xopindex{extract, using with @option{--listed-incremental}}
5942 To extract from the incremental dumps, use
5943 @option{--listed-incremental} together with @option{--extract}
5944 option (@pxref{extracting files}). In this case, @command{tar} does
5945 not need to access snapshot file, since all the data necessary for
5946 extraction are stored in the archive itself. So, when extracting, you
5947 can give whatever argument to @option{--listed-incremental}, the usual
5948 practice is to use @option{--listed-incremental=/dev/null}.
5949 Alternatively, you can use @option{--incremental}, which needs no
5950 arguments. In general, @option{--incremental} (@option{-G}) can be
5951 used as a shortcut for @option{--listed-incremental} when listing or
5952 extracting incremental backups (for more information, regarding this
5953 option, @pxref{incremental-op}).
5955 When extracting from the incremental backup @GNUTAR{} attempts to
5956 restore the exact state the file system had when the archive was
5957 created. In particular, it will @emph{delete} those files in the file
5958 system that did not exist in their directories when the archive was
5959 created. If you have created several levels of incremental files,
5960 then in order to restore the exact contents the file system had when
5961 the last level was created, you will need to restore from all backups
5962 in turn. Continuing our example, to restore the state of @file{/usr}
5963 file system, one would do@footnote{Notice, that since both archives
5964 were created without @option{-P} option (@pxref{absolute}), these
5965 commands should be run from the root file system.}:
5968 $ @kbd{tar --extract \
5969 --listed-incremental=/dev/null \
5970 --file archive.1.tar}
5971 $ @kbd{tar --extract \
5972 --listed-incremental=/dev/null \
5973 --file archive.2.tar}
5976 To list the contents of an incremental archive, use @option{--list}
5977 (@pxref{list}), as usual. To obtain more information about the
5978 archive, use @option{--listed-incremental} or @option{--incremental}
5979 combined with two @option{--verbose} options@footnote{Two
5980 @option{--verbose} options were selected to avoid breaking usual
5981 verbose listing output (@option{--list --verbose}) when using in
5984 @xopindex{incremental, using with @option{--list}}
5985 @xopindex{listed-incremental, using with @option{--list}}
5986 @xopindex{list, using with @option{--incremental}}
5987 @xopindex{list, using with @option{--listed-incremental}}
5988 Versions of @GNUTAR{} up to 1.15.1 used to dump verbatim binary
5989 contents of the DUMPDIR header (with terminating nulls) when
5990 @option{--incremental} or @option{--listed-incremental} option was
5991 given, no matter what the verbosity level. This behavior, and,
5992 especially, the binary output it produced were considered inconvenient
5993 and were changed in version 1.16}:
5996 @kbd{tar --list --incremental --verbose --verbose archive.tar}
5999 This command will print, for each directory in the archive, the list
6000 of files in that directory at the time the archive was created. This
6001 information is put out in a format which is both human-readable and
6002 unambiguous for a program: each file name is printed as
6009 where @var{x} is a letter describing the status of the file: @samp{Y}
6010 if the file is present in the archive, @samp{N} if the file is not
6011 included in the archive, or a @samp{D} if the file is a directory (and
6012 is included in the archive). @xref{Dumpdir}, for the detailed
6013 description of dumpdirs and status codes. Each such
6014 line is terminated by a newline character. The last line is followed
6015 by an additional newline to indicate the end of the data.
6017 @anchor{incremental-op}The option @option{--incremental} (@option{-G})
6018 gives the same behavior as @option{--listed-incremental} when used
6019 with @option{--list} and @option{--extract} options. When used with
6020 @option{--create} option, it creates an incremental archive without
6021 creating snapshot file. Thus, it is impossible to create several
6022 levels of incremental backups with @option{--incremental} option.
6025 @section Levels of Backups
6027 An archive containing all the files in the file system is called a
6028 @dfn{full backup} or @dfn{full dump}. You could insure your data by
6029 creating a full dump every day. This strategy, however, would waste a
6030 substantial amount of archive media and user time, as unchanged files
6031 are daily re-archived.
6033 It is more efficient to do a full dump only occasionally. To back up
6034 files between full dumps, you can use @dfn{incremental dumps}. A @dfn{level
6035 one} dump archives all the files that have changed since the last full
6038 A typical dump strategy would be to perform a full dump once a week,
6039 and a level one dump once a day. This means some versions of files
6040 will in fact be archived more than once, but this dump strategy makes
6041 it possible to restore a file system to within one day of accuracy by
6042 only extracting two archives---the last weekly (full) dump and the
6043 last daily (level one) dump. The only information lost would be in
6044 files changed or created since the last daily backup. (Doing dumps
6045 more than once a day is usually not worth the trouble).
6047 @GNUTAR{} comes with scripts you can use to do full
6048 and level-one (actually, even level-two and so on) dumps. Using
6049 scripts (shell programs) to perform backups and restoration is a
6050 convenient and reliable alternative to typing out file name lists
6051 and @command{tar} commands by hand.
6053 Before you use these scripts, you need to edit the file
6054 @file{backup-specs}, which specifies parameters used by the backup
6055 scripts and by the restore script. This file is usually located
6056 in @file{/etc/backup} directory. @xref{Backup Parameters}, for its
6057 detailed description. Once the backup parameters are set, you can
6058 perform backups or restoration by running the appropriate script.
6060 The name of the backup script is @code{backup}. The name of the
6061 restore script is @code{restore}. The following sections describe
6062 their use in detail.
6064 @emph{Please Note:} The backup and restoration scripts are
6065 designed to be used together. While it is possible to restore files by
6066 hand from an archive which was created using a backup script, and to create
6067 an archive by hand which could then be extracted using the restore script,
6068 it is easier to use the scripts. @xref{Incremental Dumps}, before
6069 making such an attempt.
6071 @node Backup Parameters
6072 @section Setting Parameters for Backups and Restoration
6074 The file @file{backup-specs} specifies backup parameters for the
6075 backup and restoration scripts provided with @command{tar}. You must
6076 edit @file{backup-specs} to fit your system configuration and schedule
6077 before using these scripts.
6079 Syntactically, @file{backup-specs} is a shell script, containing
6080 mainly variable assignments. However, any valid shell construct
6081 is allowed in this file. Particularly, you may wish to define
6082 functions within that script (e.g., see @code{RESTORE_BEGIN} below).
6083 For more information about shell script syntax, please refer to
6084 @url{http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#ta
6085 g_02, the definition of the Shell Command Language}. See also
6086 @ref{Top,,Bash Features,bashref,Bash Reference Manual}.
6088 The shell variables controlling behavior of @code{backup} and
6089 @code{restore} are described in the following subsections.
6092 * General-Purpose Variables::
6093 * Magnetic Tape Control::
6095 * backup-specs example:: An Example Text of @file{Backup-specs}
6098 @node General-Purpose Variables
6099 @subsection General-Purpose Variables
6101 @defvr {Backup variable} ADMINISTRATOR
6102 The user name of the backup administrator. @code{Backup} scripts
6103 sends a backup report to this address.
6106 @defvr {Backup variable} BACKUP_HOUR
6107 The hour at which the backups are done. This can be a number from 0
6108 to 23, or the time specification in form @var{hours}:@var{minutes},
6109 or the string @samp{now}.
6111 This variable is used by @code{backup}. Its value may be overridden
6112 using @option{--time} option (@pxref{Scripted Backups}).
6115 @defvr {Backup variable} TAPE_FILE
6117 The device @command{tar} writes the archive to. If @var{TAPE_FILE}
6118 is a remote archive (@pxref{remote-dev}), backup script will suppose
6119 that your @command{mt} is able to access remote devices. If @var{RSH}
6120 (@pxref{RSH}) is set, @option{--rsh-command} option will be added to
6121 invocations of @command{mt}.
6124 @defvr {Backup variable} BLOCKING
6126 The blocking factor @command{tar} will use when writing the dump archive.
6127 @xref{Blocking Factor}.
6130 @defvr {Backup variable} BACKUP_DIRS
6132 A list of file systems to be dumped (for @code{backup}), or restored
6133 (for @code{restore}). You can include any directory
6134 name in the list --- subdirectories on that file system will be
6135 included, regardless of how they may look to other networked machines.
6136 Subdirectories on other file systems will be ignored.
6138 The host name specifies which host to run @command{tar} on, and should
6139 normally be the host that actually contains the file system. However,
6140 the host machine must have @GNUTAR{} installed, and
6141 must be able to access the directory containing the backup scripts and
6142 their support files using the same file name that is used on the
6143 machine where the scripts are run (i.e., what @command{pwd} will print
6144 when in that directory on that machine). If the host that contains
6145 the file system does not have this capability, you can specify another
6146 host as long as it can access the file system through @acronym{NFS}.
6148 If the list of file systems is very long you may wish to put it
6149 in a separate file. This file is usually named
6150 @file{/etc/backup/dirs}, but this name may be overridden in
6151 @file{backup-specs} using @code{DIRLIST} variable.
6154 @defvr {Backup variable} DIRLIST
6156 The name of the file that contains a list of file systems to backup
6157 or restore. By default it is @file{/etc/backup/dirs}.
6160 @defvr {Backup variable} BACKUP_FILES
6162 A list of individual files to be dumped (for @code{backup}), or restored
6163 (for @code{restore}). These should be accessible from the machine on
6164 which the backup script is run.
6166 If the list of file systems is very long you may wish to store it
6167 in a separate file. This file is usually named
6168 @file{/etc/backup/files}, but this name may be overridden in
6169 @file{backup-specs} using @code{FILELIST} variable.
6172 @defvr {Backup variable} FILELIST
6174 The name of the file that contains a list of individual files to backup
6175 or restore. By default it is @file{/etc/backup/files}.
6178 @defvr {Backup variable} MT
6180 Full file name of @command{mt} binary.
6183 @defvr {Backup variable} RSH
6185 Full file name of @command{rsh} binary or its equivalent. You may wish to
6186 set it to @code{ssh}, to improve security. In this case you will have
6187 to use public key authentication.
6190 @defvr {Backup variable} RSH_COMMAND
6192 Full file name of @command{rsh} binary on remote machines. This will
6193 be passed via @option{--rsh-command} option to the remote invocation
6197 @defvr {Backup variable} VOLNO_FILE
6199 Name of temporary file to hold volume numbers. This needs to be accessible
6200 by all the machines which have file systems to be dumped.
6203 @defvr {Backup variable} XLIST
6205 Name of @dfn{exclude file list}. An @dfn{exclude file list} is a file
6206 located on the remote machine and containing the list of files to
6207 be excluded from the backup. Exclude file lists are searched in
6208 /etc/tar-backup directory. A common use for exclude file lists
6209 is to exclude files containing security-sensitive information
6210 (e.g., @file{/etc/shadow} from backups).
6212 This variable affects only @code{backup}.
6215 @defvr {Backup variable} SLEEP_TIME
6217 Time to sleep between dumps of any two successive file systems
6219 This variable affects only @code{backup}.
6222 @defvr {Backup variable} DUMP_REMIND_SCRIPT
6224 Script to be run when it's time to insert a new tape in for the next
6225 volume. Administrators may want to tailor this script for their site.
6226 If this variable isn't set, @GNUTAR{} will display its built-in
6227 prompt, and will expect confirmation from the console. For the
6228 description of the default prompt, see @ref{change volume prompt}.
6232 @defvr {Backup variable} SLEEP_MESSAGE
6234 Message to display on the terminal while waiting for dump time. Usually
6235 this will just be some literal text.
6238 @defvr {Backup variable} TAR
6240 Full file name of the @GNUTAR{} executable. If this is not set, backup
6241 scripts will search @command{tar} in the current shell path.
6244 @node Magnetic Tape Control
6245 @subsection Magnetic Tape Control
6247 Backup scripts access tape device using special @dfn{hook functions}.
6248 These functions take a single argument -- the name of the tape
6249 device. Their names are kept in the following variables:
6251 @defvr {Backup variable} MT_BEGIN
6252 The name of @dfn{begin} function. This function is called before
6253 accessing the drive. By default it retensions the tape:
6259 mt -f "$1" retension
6264 @defvr {Backup variable} MT_REWIND
6265 The name of @dfn{rewind} function. The default definition is as
6278 @defvr {Backup variable} MT_OFFLINE
6279 The name of the function switching the tape off line. By default
6280 it is defined as follows:
6283 MT_OFFLINE=mt_offline
6291 @defvr {Backup variable} MT_STATUS
6292 The name of the function used to obtain the status of the archive device,
6293 including error count. Default definition:
6305 @subsection User Hooks
6307 @dfn{User hooks} are shell functions executed before and after
6308 each @command{tar} invocation. Thus, there are @dfn{backup
6309 hooks}, which are executed before and after dumping each file
6310 system, and @dfn{restore hooks}, executed before and
6311 after restoring a file system. Each user hook is a shell function
6312 taking four arguments:
6314 @deffn {User Hook Function} hook @var{level} @var{host} @var{fs} @var{fsname}
6319 Current backup or restore level.
6322 Name or IP address of the host machine being dumped or restored.
6325 Full file name of the file system being dumped or restored.
6328 File system name with directory separators replaced with colons. This
6329 is useful, e.g., for creating unique files.
6333 Following variables keep the names of user hook functions
6335 @defvr {Backup variable} DUMP_BEGIN
6336 Dump begin function. It is executed before dumping the file system.
6339 @defvr {Backup variable} DUMP_END
6340 Executed after dumping the file system.
6343 @defvr {Backup variable} RESTORE_BEGIN
6344 Executed before restoring the file system.
6347 @defvr {Backup variable} RESTORE_END
6348 Executed after restoring the file system.
6351 @node backup-specs example
6352 @subsection An Example Text of @file{Backup-specs}
6354 The following is an example of @file{backup-specs}:
6357 # site-specific parameters for file system backup.
6359 ADMINISTRATOR=friedman
6361 TAPE_FILE=/dev/nrsmt0
6363 # Use @code{ssh} instead of the less secure @code{rsh}
6365 RSH_COMMAND=/usr/bin/ssh
6367 # Override MT_STATUS function:
6373 # Disable MT_OFFLINE function
6390 apple-gunkies:/com/mailer/gnu
6391 apple-gunkies:/com/archive/gnu"
6393 BACKUP_FILES="/com/mailer/aliases /com/mailer/league*[a-z]"
6397 @node Scripted Backups
6398 @section Using the Backup Scripts
6400 The syntax for running a backup script is:
6403 backup --level=@var{level} --time=@var{time}
6406 The @option{level} option requests the dump level. Thus, to produce
6407 a full dump, specify @code{--level=0} (this is the default, so
6408 @option{--level} may be omitted if its value is @code{0}).
6409 @footnote{For backward compatibility, the @code{backup} will also
6410 try to deduce the requested dump level from the name of the
6411 script itself. If the name consists of a string @samp{level-}
6412 followed by a single decimal digit, that digit is taken as
6413 the dump level number. Thus, you may create a link from @code{backup}
6414 to @code{level-1} and then run @code{level-1} whenever you need to
6415 create a level one dump.}
6417 The @option{--time} option determines when should the backup be
6418 run. @var{Time} may take three forms:
6421 @item @var{hh}:@var{mm}
6423 The dump must be run at @var{hh} hours @var{mm} minutes.
6427 The dump must be run at @var{hh} hours
6431 The dump must be run immediately.
6434 You should start a script with a tape or disk mounted. Once you
6435 start a script, it prompts you for new tapes or disks as it
6436 needs them. Media volumes don't have to correspond to archive
6437 files --- a multi-volume archive can be started in the middle of a
6438 tape that already contains the end of another multi-volume archive.
6439 The @code{restore} script prompts for media by its archive volume,
6440 so to avoid an error message you should keep track of which tape
6441 (or disk) contains which volume of the archive (@pxref{Scripted
6444 The backup scripts write two files on the file system. The first is a
6445 record file in @file{/etc/tar-backup/}, which is used by the scripts
6446 to store and retrieve information about which files were dumped. This
6447 file is not meant to be read by humans, and should not be deleted by
6448 them. @xref{Snapshot Files}, for a more detailed explanation of this
6451 The second file is a log file containing the names of the file systems
6452 and files dumped, what time the backup was made, and any error
6453 messages that were generated, as well as how much space was left in
6454 the media volume after the last volume of the archive was written.
6455 You should check this log file after every backup. The file name is
6456 @file{log-@var{mm-dd-yyyy}-level-@var{n}}, where @var{mm-dd-yyyy}
6457 represents current date, and @var{n} represents current dump level number.
6459 The script also prints the name of each system being dumped to the
6462 Following is the full list of options accepted by @code{backup}
6466 @item -l @var{level}
6467 @itemx --level=@var{level}
6468 Do backup level @var{level} (default 0).
6472 Force backup even if today's log file already exists.
6474 @item -v[@var{level}]
6475 @itemx --verbose[=@var{level}]
6476 Set verbosity level. The higher the level is, the more debugging
6477 information will be output during execution. Default @var{level}
6478 is 100, which means the highest debugging level.
6480 @item -t @var{start-time}
6481 @itemx --time=@var{start-time}
6482 Wait till @var{time}, then do backup.
6486 Display short help message and exit.
6490 Display information about the program's name, version, origin and legal
6491 status, all on standard output, and then exit successfully.
6495 @node Scripted Restoration
6496 @section Using the Restore Script
6498 To restore files that were archived using a scripted backup, use the
6499 @code{restore} script. Its usage is quite straightforward. In the
6500 simplest form, invoke @code{restore --all}, it will
6501 then restore all the file systems and files specified in
6502 @file{backup-specs} (@pxref{General-Purpose Variables,BACKUP_DIRS}).
6504 You may select the file systems (and/or files) to restore by
6505 giving @code{restore} list of @dfn{patterns} in its command
6506 line. For example, running
6513 will restore all file systems on the machine @samp{albert}. A more
6514 complicated example:
6517 restore 'albert:*' '*:/var'
6521 This command will restore all file systems on the machine @samp{albert}
6522 as well as @file{/var} file system on all machines.
6524 By default @code{restore} will start restoring files from the lowest
6525 available dump level (usually zero) and will continue through
6526 all available dump levels. There may be situations where such a
6527 thorough restore is not necessary. For example, you may wish to
6528 restore only files from the recent level one backup. To do so,
6529 use @option{--level} option, as shown in the example below:
6535 The full list of options accepted by @code{restore} follows:
6540 Restore all file systems and files specified in @file{backup-specs}
6542 @item -l @var{level}
6543 @itemx --level=@var{level}
6544 Start restoring from the given backup level, instead of the default 0.
6546 @item -v[@var{level}]
6547 @itemx --verbose[=@var{level}]
6548 Set verbosity level. The higher the level is, the more debugging
6549 information will be output during execution. Default @var{level}
6550 is 100, which means the highest debugging level.
6554 Display short help message and exit.
6558 Display information about the program's name, version, origin and legal
6559 status, all on standard output, and then exit successfully.
6562 You should start the restore script with the media containing the
6563 first volume of the archive mounted. The script will prompt for other
6564 volumes as they are needed. If the archive is on tape, you don't need
6565 to rewind the tape to to its beginning---if the tape head is
6566 positioned past the beginning of the archive, the script will rewind
6567 the tape as needed. @xref{Tape Positioning}, for a discussion of tape
6571 @strong{Warning:} The script will delete files from the active file
6572 system if they were not in the file system when the archive was made.
6575 @xref{Incremental Dumps}, for an explanation of how the script makes
6579 @chapter Choosing Files and Names for @command{tar}
6581 Certain options to @command{tar} enable you to specify a name for your
6582 archive. Other options let you decide which files to include or exclude
6583 from the archive, based on when or whether files were modified, whether
6584 the file names do or don't match specified patterns, or whether files
6585 are in specified directories.
6587 This chapter discusses these options in detail.
6590 * file:: Choosing the Archive's Name
6591 * Selecting Archive Members::
6592 * files:: Reading Names from a File
6593 * exclude:: Excluding Some Files
6594 * wildcards:: Wildcards Patterns and Matching
6595 * quoting styles:: Ways of Quoting Special Characters in Names
6596 * transform:: Modifying File and Member Names
6597 * after:: Operating Only on New Files
6598 * recurse:: Descending into Directories
6599 * one:: Crossing File System Boundaries
6603 @section Choosing and Naming Archive Files
6605 @cindex Naming an archive
6606 @cindex Archive Name
6607 @cindex Choosing an archive file
6608 @cindex Where is the archive?
6610 By default, @command{tar} uses an archive file name that was compiled when
6611 it was built on the system; usually this name refers to some physical
6612 tape drive on the machine. However, the person who installed @command{tar}
6613 on the system may not have set the default to a meaningful value as far as
6614 most users are concerned. As a result, you will usually want to tell
6615 @command{tar} where to find (or create) the archive. The
6616 @option{--file=@var{archive-name}} (@option{-f @var{archive-name}})
6617 option allows you to either specify or name a file to use as the archive
6618 instead of the default archive file location.
6621 @xopindex{file, short description}
6622 @item --file=@var{archive-name}
6623 @itemx -f @var{archive-name}
6624 Name the archive to create or operate on. Use in conjunction with
6628 For example, in this @command{tar} command,
6631 $ @kbd{tar -cvf collection.tar blues folk jazz}
6635 @file{collection.tar} is the name of the archive. It must directly
6636 follow the @option{-f} option, since whatever directly follows @option{-f}
6637 @emph{will} end up naming the archive. If you neglect to specify an
6638 archive name, you may end up overwriting a file in the working directory
6639 with the archive you create since @command{tar} will use this file's name
6640 for the archive name.
6642 An archive can be saved as a file in the file system, sent through a
6643 pipe or over a network, or written to an I/O device such as a tape,
6644 floppy disk, or CD write drive.
6646 @cindex Writing new archives
6647 @cindex Archive creation
6648 If you do not name the archive, @command{tar} uses the value of the
6649 environment variable @env{TAPE} as the file name for the archive. If
6650 that is not available, @command{tar} uses a default, compiled-in archive
6651 name, usually that for tape unit zero (i.e., @file{/dev/tu00}).
6653 @cindex Standard input and output
6654 @cindex tar to standard input and output
6655 If you use @file{-} as an @var{archive-name}, @command{tar} reads the
6656 archive from standard input (when listing or extracting files), or
6657 writes it to standard output (when creating an archive). If you use
6658 @file{-} as an @var{archive-name} when modifying an archive,
6659 @command{tar} reads the original archive from its standard input and
6660 writes the entire new archive to its standard output.
6662 The following example is a convenient way of copying directory
6663 hierarchy from @file{sourcedir} to @file{targetdir}.
6666 $ @kbd{(cd sourcedir; tar -cf - .) | (cd targetdir; tar -xpf -)}
6669 The @option{-C} option allows to avoid using subshells:
6672 $ @kbd{tar -C sourcedir -cf - . | tar -C targetdir -xpf -}
6675 In both examples above, the leftmost @command{tar} invocation archives
6676 the contents of @file{sourcedir} to the standard output, while the
6677 rightmost one reads this archive from its standard input and
6678 extracts it. The @option{-p} option tells it to restore permissions
6679 of the extracted files.
6681 @cindex Remote devices
6682 @cindex tar to a remote device
6684 To specify an archive file on a device attached to a remote machine,
6688 @kbd{--file=@var{hostname}:/@var{dev}/@var{file-name}}
6692 @command{tar} will complete the remote connection, if possible, and
6693 prompt you for a username and password. If you use
6694 @option{--file=@@@var{hostname}:/@var{dev}/@var{file-name}}, @command{tar}
6695 will complete the remote connection, if possible, using your username
6696 as the username on the remote machine.
6698 @cindex Local and remote archives
6699 @anchor{local and remote archives}
6700 If the archive file name includes a colon (@samp{:}), then it is assumed
6701 to be a file on another machine. If the archive file is
6702 @samp{@var{user}@@@var{host}:@var{file}}, then @var{file} is used on the
6703 host @var{host}. The remote host is accessed using the @command{rsh}
6704 program, with a username of @var{user}. If the username is omitted
6705 (along with the @samp{@@} sign), then your user name will be used.
6706 (This is the normal @command{rsh} behavior.) It is necessary for the
6707 remote machine, in addition to permitting your @command{rsh} access, to
6708 have the @file{rmt} program installed (This command is included in
6709 the @GNUTAR{} distribution and by default is installed under
6710 @file{@var{prefix}/libexec/rmt}, were @var{prefix} means your
6711 installation prefix). If you need to use a file whose name includes a
6712 colon, then the remote tape drive behavior
6713 can be inhibited by using the @option{--force-local} option.
6715 When the archive is being created to @file{/dev/null}, @GNUTAR{}
6716 tries to minimize input and output operations. The Amanda backup
6717 system, when used with @GNUTAR{}, has an initial sizing pass which
6720 @node Selecting Archive Members
6721 @section Selecting Archive Members
6722 @cindex Specifying files to act on
6723 @cindex Specifying archive members
6725 @dfn{File Name arguments} specify which files in the file system
6726 @command{tar} operates on, when creating or adding to an archive, or which
6727 archive members @command{tar} operates on, when reading or deleting from
6728 an archive. @xref{Operations}.
6730 To specify file names, you can include them as the last arguments on
6731 the command line, as follows:
6733 @kbd{tar} @var{operation} [@var{option1} @var{option2} @dots{}] [@var{file name-1} @var{file name-2} @dots{}]
6736 If a file name begins with dash (@samp{-}), precede it with
6737 @option{--add-file} option to prevent it from being treated as an
6740 @anchor{input name quoting}
6741 By default @GNUTAR{} attempts to @dfn{unquote} each file or member
6742 name, replacing @dfn{escape sequences} according to the following
6745 @multitable @columnfractions 0.20 0.60
6746 @headitem Escape @tab Replaced with
6747 @item \a @tab Audible bell (@acronym{ASCII} 7)
6748 @item \b @tab Backspace (@acronym{ASCII} 8)
6749 @item \f @tab Form feed (@acronym{ASCII} 12)
6750 @item \n @tab New line (@acronym{ASCII} 10)
6751 @item \r @tab Carriage return (@acronym{ASCII} 13)
6752 @item \t @tab Horizontal tabulation (@acronym{ASCII} 9)
6753 @item \v @tab Vertical tabulation (@acronym{ASCII} 11)
6754 @item \? @tab @acronym{ASCII} 127
6755 @item \@var{n} @tab @acronym{ASCII} @var{n} (@var{n} should be an octal number
6759 A backslash followed by any other symbol is retained.
6761 This default behavior is controlled by the following command line
6767 Enable unquoting input file or member names (default).
6771 Disable unquoting input file or member names.
6774 If you specify a directory name as a file name argument, all the files
6775 in that directory are operated on by @command{tar}.
6777 If you do not specify files, @command{tar} behavior differs depending
6778 on the operation mode as described below:
6780 When @command{tar} is invoked with @option{--create} (@option{-c}),
6781 @command{tar} will stop immediately, reporting the following:
6785 $ @kbd{tar cf a.tar}
6786 tar: Cowardly refusing to create an empty archive
6787 Try `tar --help' or `tar --usage' for more information.
6791 If you specify either @option{--list} (@option{-t}) or
6792 @option{--extract} (@option{--get}, @option{-x}), @command{tar}
6793 operates on all the archive members in the archive.
6795 If run with @option{--diff} option, tar will compare the archive with
6796 the contents of the current working directory.
6798 If you specify any other operation, @command{tar} does nothing.
6800 By default, @command{tar} takes file names from the command line. However,
6801 there are other ways to specify file or member names, or to modify the
6802 manner in which @command{tar} selects the files or members upon which to
6803 operate. In general, these methods work both for specifying the names
6804 of files and archive members.
6807 @section Reading Names from a File
6809 @cindex Reading file names from a file
6810 @cindex Lists of file names
6811 @cindex File Name arguments, alternatives
6812 @cindex @command{find}, using with @command{tar}
6813 Instead of giving the names of files or archive members on the command
6814 line, you can put the names into a file, and then use the
6815 @option{--files-from=@var{file-of-names}} (@option{-T
6816 @var{file-of-names}}) option to @command{tar}. Give the name of the
6817 file which contains the list of files to include as the argument to
6818 @option{--files-from}. In the list, the file names should be separated by
6819 newlines. You will frequently use this option when you have generated
6820 the list of files to archive with the @command{find} utility.
6824 @item --files-from=@var{file-name}
6825 @itemx -T @var{file-name}
6826 Get names to extract or create from file @var{file-name}.
6829 If you give a single dash as a file name for @option{--files-from}, (i.e.,
6830 you specify either @code{--files-from=-} or @code{-T -}), then the file
6831 names are read from standard input.
6833 Unless you are running @command{tar} with @option{--create}, you can not use
6834 both @code{--files-from=-} and @code{--file=-} (@code{-f -}) in the same
6837 Any number of @option{-T} options can be given in the command line.
6839 The following example shows how to use @command{find} to generate a list of
6840 files smaller than 400K in length and put that list into a file
6841 called @file{small-files}. You can then use the @option{-T} option to
6842 @command{tar} to specify the files from that file, @file{small-files}, to
6843 create the archive @file{little.tgz}. (The @option{-z} option to
6844 @command{tar} compresses the archive with @command{gzip}; @pxref{gzip} for
6848 $ @kbd{find . -size -400 -print > small-files}
6849 $ @kbd{tar -c -v -z -T small-files -f little.tgz}
6853 In the file list given by @option{-T} option, any file name beginning
6854 with @samp{-} character is considered a @command{tar} option and is
6855 processed accordingly.@footnote{Versions of @GNUTAR{} up to 1.15.1
6856 recognized only @option{-C} option in file lists, and only if the
6857 option and its argument occupied two consecutive lines.} For example,
6858 the common use of this feature is to change to another directory by
6859 specifying @option{-C} option:
6869 $ @kbd{tar -c -f foo.tar --files-from list}
6874 In this example, @command{tar} will first switch to @file{/etc}
6875 directory and add files @file{passwd} and @file{hosts} to the
6876 archive. Then it will change to @file{/lib} directory and will archive
6877 the file @file{libc.a}. Thus, the resulting archive @file{foo.tar} will
6882 $ @kbd{tar tf foo.tar}
6890 @xopindex{directory, using in @option{--files-from} argument}
6891 Notice that the option parsing algorithm used with @option{-T} is
6892 stricter than the one used by shell. Namely, when specifying option
6893 arguments, you should observe the following rules:
6897 When using short (single-letter) option form, its argument must
6898 immediately follow the option letter, without any intervening
6899 whitespace. For example: @code{-Cdir}.
6902 When using long option form, the option argument must be separated
6903 from the option by a single equal sign. No whitespace is allowed on
6904 any side of the equal sign. For example: @code{--directory=dir}.
6907 For both short and long option forms, the option argument can be given
6908 on the next line after the option name, e.g.:
6929 If you happen to have a file whose name starts with @samp{-},
6930 precede it with @option{--add-file} option to prevent it from
6931 being recognized as an option. For example: @code{--add-file=--my-file}.
6938 @subsection @code{NUL} Terminated File Names
6940 @cindex File names, terminated by @code{NUL}
6941 @cindex @code{NUL} terminated file names
6942 The @option{--null} option causes
6943 @option{--files-from=@var{file-of-names}} (@option{-T @var{file-of-names}})
6944 to read file names terminated by a @code{NUL} instead of a newline, so
6945 files whose names contain newlines can be archived using
6946 @option{--files-from}.
6949 @xopindex{null, described}
6951 Only consider @code{NUL} terminated file names, instead of files that
6952 terminate in a newline.
6954 @xopindex{no-null, described}
6956 Undo the effect of any previous @option{--null} option.
6959 The @option{--null} option is just like the one in @acronym{GNU}
6960 @command{xargs} and @command{cpio}, and is useful with the
6961 @option{-print0} predicate of @acronym{GNU} @command{find}. In
6962 @command{tar}, @option{--null} also disables special handling for
6963 file names that begin with dash.
6965 This example shows how to use @command{find} to generate a list of files
6966 larger than 800K in length and put that list into a file called
6967 @file{long-files}. The @option{-print0} option to @command{find} is just
6968 like @option{-print}, except that it separates files with a @code{NUL}
6969 rather than with a newline. You can then run @command{tar} with both the
6970 @option{--null} and @option{-T} options to specify that @command{tar} get the
6971 files from that file, @file{long-files}, to create the archive
6972 @file{big.tgz}. The @option{--null} option to @command{tar} will cause
6973 @command{tar} to recognize the @code{NUL} separator between files.
6976 $ @kbd{find . -size +800 -print0 > long-files}
6977 $ @kbd{tar -c -v --null --files-from=long-files --file=big.tar}
6980 The @option{--no-null} option can be used if you need to read both
6981 zero-terminated and newline-terminated files on the same command line.
6982 For example, if @file{flist} is a newline-terminated file, then the
6983 following command can be used to combine it with the above command:
6987 $ @kbd{find . -size +800 -print0 |
6988 tar -c -f big.tar --null -T - --no-null -T flist}
6992 This example uses short options for typographic reasons, to avoid
6995 @GNUTAR is able to automatically detect null-terminated file lists, so
6996 it is safe to use them even without the @option{--null} option. In
6997 this case @command{tar} will print a warning and continue reading such
6998 a file as if @option{--null} were actually given:
7002 $ @kbd{find . -size +800 -print0 | tar -c -f big.tar -T -}
7003 tar: -: file name read contains nul character
7007 The null terminator, however, remains in effect only for this
7008 particular file, any following @option{-T} options will assume
7009 newline termination. Of course, the null autodetection applies
7010 to these eventual surplus @option{-T} options as well.
7013 @section Excluding Some Files
7015 @cindex File names, excluding files by
7016 @cindex Excluding files by name and pattern
7017 @cindex Excluding files by file system
7019 @opindex exclude-from
7020 To avoid operating on files whose names match a particular pattern,
7021 use the @option{--exclude} or @option{--exclude-from} options.
7025 @item --exclude=@var{pattern}
7026 Causes @command{tar} to ignore files that match the @var{pattern}.
7030 The @option{--exclude=@var{pattern}} option prevents any file or
7031 member whose name matches the shell wildcard (@var{pattern}) from
7033 For example, to create an archive with all the contents of the directory
7034 @file{src} except for files whose names end in @file{.o}, use the
7035 command @samp{tar -cf src.tar --exclude='*.o' src}.
7037 You may give multiple @option{--exclude} options.
7040 @opindex exclude-from
7041 @item --exclude-from=@var{file}
7042 @itemx -X @var{file}
7043 Causes @command{tar} to ignore files that match the patterns listed in
7047 @findex exclude-from
7048 Use the @option{--exclude-from} option to read a
7049 list of patterns, one per line, from @var{file}; @command{tar} will
7050 ignore files matching those patterns. Thus if @command{tar} is
7051 called as @w{@samp{tar -c -X foo .}} and the file @file{foo} contains a
7052 single line @file{*.o}, no files whose names end in @file{.o} will be
7053 added to the archive.
7055 Notice, that lines from @var{file} are read verbatim. One of the
7056 frequent errors is leaving some extra whitespace after a file name,
7057 which is difficult to catch using text editors.
7059 However, empty lines are OK.
7061 @cindex version control system, excluding files
7062 @cindex VCS, excluding files
7063 @cindex SCCS, excluding files
7064 @cindex RCS, excluding files
7065 @cindex CVS, excluding files
7066 @cindex SVN, excluding files
7067 @cindex git, excluding files
7068 @cindex Bazaar, excluding files
7069 @cindex Arch, excluding files
7070 @cindex Mercurial, excluding files
7071 @cindex Darcs, excluding files
7073 @opindex exclude-vcs
7075 Exclude files and directories used by following version control
7076 systems: @samp{CVS}, @samp{RCS}, @samp{SCCS}, @samp{SVN}, @samp{Arch},
7077 @samp{Bazaar}, @samp{Mercurial}, and @samp{Darcs}.
7080 As of version @value{VERSION}, the following files are excluded:
7083 @item @file{CVS/}, and everything under it
7084 @item @file{RCS/}, and everything under it
7085 @item @file{SCCS/}, and everything under it
7086 @item @file{.git/}, and everything under it
7087 @item @file{.gitignore}
7088 @item @file{.cvsignore}
7089 @item @file{.svn/}, and everything under it
7090 @item @file{.arch-ids/}, and everything under it
7091 @item @file{@{arch@}/}, and everything under it
7092 @item @file{=RELEASE-ID}
7093 @item @file{=meta-update}
7094 @item @file{=update}
7096 @item @file{.bzrignore}
7097 @item @file{.bzrtags}
7099 @item @file{.hgignore}
7100 @item @file{.hgrags}
7104 @findex exclude-caches
7105 When creating an archive, the @option{--exclude-caches} option family
7106 causes @command{tar} to exclude all directories that contain a @dfn{cache
7107 directory tag}. A cache directory tag is a short file with the
7108 well-known name @file{CACHEDIR.TAG} and having a standard header
7109 specified in @url{http://www.brynosaurus.com/cachedir/spec.html}.
7110 Various applications write cache directory tags into directories they
7111 use to hold regenerable, non-precious data, so that such data can be
7112 more easily excluded from backups.
7114 There are three @samp{exclude-caches} options, each providing a different
7115 exclusion semantics:
7118 @opindex exclude-caches
7119 @item --exclude-caches
7120 Do not archive the contents of the directory, but archive the
7121 directory itself and the @file{CACHEDIR.TAG} file.
7123 @opindex exclude-caches-under
7124 @item --exclude-caches-under
7125 Do not archive the contents of the directory, nor the
7126 @file{CACHEDIR.TAG} file, archive only the directory itself.
7128 @opindex exclude-caches-all
7129 @item --exclude-caches-all
7130 Omit directories containing @file{CACHEDIR.TAG} file entirely.
7134 Another option family, @option{--exclude-tag}, provides a generalization of
7135 this concept. It takes a single argument, a file name to look for.
7136 Any directory that contains this file will be excluded from the dump.
7137 Similarly to @samp{exclude-caches}, there are three options in this
7141 @opindex exclude-tag
7142 @item --exclude-tag=@var{file}
7143 Do not dump the contents of the directory, but dump the
7144 directory itself and the @var{file}.
7146 @opindex exclude-tag-under
7147 @item --exclude-tag-under=@var{file}
7148 Do not dump the contents of the directory, nor the
7149 @var{file}, archive only the directory itself.
7151 @opindex exclude-tag-all
7152 @item --exclude-tag-all=@var{file}
7153 Omit directories containing @var{file} file entirely.
7156 Multiple @option{--exclude-tag*} options can be given.
7158 For example, given this directory:
7173 The @option{--exclude-tag} will produce the following:
7176 $ @kbd{tar -cf archive.tar --exclude-tag=tagfile -v dir}
7181 tar: dir/folk/: contains a cache directory tag tagfile;
7186 Both the @file{dir/folk} directory and its tagfile are preserved in
7187 the archive, however the rest of files in this directory are not.
7189 Now, using the @option{--exclude-tag-under} option will exclude
7190 @file{tagfile} from the dump, while still preserving the directory
7191 itself, as shown in this example:
7194 $ @kbd{tar -cf archive.tar --exclude-tag-under=tagfile -v dir}
7199 ./tar: dir/folk/: contains a cache directory tag tagfile;
7203 Finally, using @option{--exclude-tag-all} omits the @file{dir/folk}
7207 $ @kbd{tar -cf archive.tar --exclude-tag-all=tagfile -v dir}
7211 ./tar: dir/folk/: contains a cache directory tag tagfile;
7212 directory not dumped
7216 * problems with exclude::
7219 @node problems with exclude
7220 @unnumberedsubsec Problems with Using the @code{exclude} Options
7222 @xopindex{exclude, potential problems with}
7223 Some users find @samp{exclude} options confusing. Here are some common
7228 The main operating mode of @command{tar} does not act on a file name
7229 explicitly listed on the command line, if one of its file name
7230 components is excluded. In the example above, if
7231 you create an archive and exclude files that end with @samp{*.o}, but
7232 explicitly name the file @samp{dir.o/foo} after all the options have been
7233 listed, @samp{dir.o/foo} will be excluded from the archive.
7236 You can sometimes confuse the meanings of @option{--exclude} and
7237 @option{--exclude-from}. Be careful: use @option{--exclude} when files
7238 to be excluded are given as a pattern on the command line. Use
7239 @option{--exclude-from} to introduce the name of a file which contains
7240 a list of patterns, one per line; each of these patterns can exclude
7241 zero, one, or many files.
7244 When you use @option{--exclude=@var{pattern}}, be sure to quote the
7245 @var{pattern} parameter, so @GNUTAR{} sees wildcard characters
7246 like @samp{*}. If you do not do this, the shell might expand the
7247 @samp{*} itself using files at hand, so @command{tar} might receive a
7248 list of files instead of one pattern, or none at all, making the
7249 command somewhat illegal. This might not correspond to what you want.
7254 $ @kbd{tar -c -f @var{archive.tar} --exclude '*.o' @var{directory}}
7262 $ @kbd{tar -c -f @var{archive.tar} --exclude *.o @var{directory}}
7266 You must use use shell syntax, or globbing, rather than @code{regexp}
7267 syntax, when using exclude options in @command{tar}. If you try to use
7268 @code{regexp} syntax to describe files to be excluded, your command
7272 @FIXME{The change in semantics must have occurred before 1.11,
7273 so I doubt if it is worth mentioning at all. Anyway, should at
7274 least specify in which version the semantics changed.}
7275 In earlier versions of @command{tar}, what is now the
7276 @option{--exclude-from} option was called @option{--exclude} instead.
7277 Now, @option{--exclude} applies to patterns listed on the command
7278 line and @option{--exclude-from} applies to patterns listed in a
7284 @section Wildcards Patterns and Matching
7286 @dfn{Globbing} is the operation by which @dfn{wildcard} characters,
7287 @samp{*} or @samp{?} for example, are replaced and expanded into all
7288 existing files matching the given pattern. @GNUTAR{} can use wildcard
7289 patterns for matching (or globbing) archive members when extracting
7290 from or listing an archive. Wildcard patterns are also used for
7291 verifying volume labels of @command{tar} archives. This section has the
7292 purpose of explaining wildcard syntax for @command{tar}.
7294 @FIXME{the next few paragraphs need work.}
7296 A @var{pattern} should be written according to shell syntax, using wildcard
7297 characters to effect globbing. Most characters in the pattern stand
7298 for themselves in the matched string, and case is significant: @samp{a}
7299 will match only @samp{a}, and not @samp{A}. The character @samp{?} in the
7300 pattern matches any single character in the matched string. The character
7301 @samp{*} in the pattern matches zero, one, or more single characters in
7302 the matched string. The character @samp{\} says to take the following
7303 character of the pattern @emph{literally}; it is useful when one needs to
7304 match the @samp{?}, @samp{*}, @samp{[} or @samp{\} characters, themselves.
7306 The character @samp{[}, up to the matching @samp{]}, introduces a character
7307 class. A @dfn{character class} is a list of acceptable characters
7308 for the next single character of the matched string. For example,
7309 @samp{[abcde]} would match any of the first five letters of the alphabet.
7310 Note that within a character class, all of the ``special characters''
7311 listed above other than @samp{\} lose their special meaning; for example,
7312 @samp{[-\\[*?]]} would match any of the characters, @samp{-}, @samp{\},
7313 @samp{[}, @samp{*}, @samp{?}, or @samp{]}. (Due to parsing constraints,
7314 the characters @samp{-} and @samp{]} must either come @emph{first} or
7315 @emph{last} in a character class.)
7317 @cindex Excluding characters from a character class
7318 @cindex Character class, excluding characters from
7319 If the first character of the class after the opening @samp{[}
7320 is @samp{!} or @samp{^}, then the meaning of the class is reversed.
7321 Rather than listing character to match, it lists those characters which
7322 are @emph{forbidden} as the next single character of the matched string.
7324 Other characters of the class stand for themselves. The special
7325 construction @samp{[@var{a}-@var{e}]}, using an hyphen between two
7326 letters, is meant to represent all characters between @var{a} and
7329 @FIXME{need to add a sentence or so here to make this clear for those
7330 who don't have dan around.}
7332 Periods (@samp{.}) or forward slashes (@samp{/}) are not considered
7333 special for wildcard matches. However, if a pattern completely matches
7334 a directory prefix of a matched string, then it matches the full matched
7335 string: thus, excluding a directory also excludes all the files beneath it.
7338 * controlling pattern-matching::
7341 @node controlling pattern-matching
7342 @unnumberedsubsec Controlling Pattern-Matching
7344 For the purposes of this section, we call @dfn{exclusion members} all
7345 member names obtained while processing @option{--exclude} and
7346 @option{--exclude-from} options, and @dfn{inclusion members} those
7347 member names that were given in the command line or read from the file
7348 specified with @option{--files-from} option.
7350 These two pairs of member lists are used in the following operations:
7351 @option{--diff}, @option{--extract}, @option{--list},
7354 There are no inclusion members in create mode (@option{--create} and
7355 @option{--append}), since in this mode the names obtained from the
7356 command line refer to @emph{files}, not archive members.
7358 By default, inclusion members are compared with archive members
7359 literally @footnote{Notice that earlier @GNUTAR{} versions used
7360 globbing for inclusion members, which contradicted to UNIX98
7361 specification and was not documented. @xref{Changes}, for more
7362 information on this and other changes.} and exclusion members are
7363 treated as globbing patterns. For example:
7367 $ @kbd{tar tf foo.tar}
7372 # @i{Member names are used verbatim:}
7373 $ @kbd{tar -xf foo.tar -v '[remarks]'}
7375 # @i{Exclude member names are globbed:}
7376 $ @kbd{tar -xf foo.tar -v --exclude '*.c'}
7382 This behavior can be altered by using the following options:
7387 Treat all member names as wildcards.
7389 @opindex no-wildcards
7390 @item --no-wildcards
7391 Treat all member names as literal strings.
7394 Thus, to extract files whose names end in @samp{.c}, you can use:
7397 $ @kbd{tar -xf foo.tar -v --wildcards '*.c'}
7403 Notice quoting of the pattern to prevent the shell from interpreting
7406 The effect of @option{--wildcards} option is canceled by
7407 @option{--no-wildcards}. This can be used to pass part of
7408 the command line arguments verbatim and other part as globbing
7409 patterns. For example, the following invocation:
7412 $ @kbd{tar -xf foo.tar --wildcards '*.txt' --no-wildcards '[remarks]'}
7416 instructs @command{tar} to extract from @file{foo.tar} all files whose
7417 names end in @samp{.txt} and the file named @file{[remarks]}.
7419 Normally, a pattern matches a name if an initial subsequence of the
7420 name's components matches the pattern, where @samp{*}, @samp{?}, and
7421 @samp{[...]} are the usual shell wildcards, @samp{\} escapes wildcards,
7422 and wildcards can match @samp{/}.
7424 Other than optionally stripping leading @samp{/} from names
7425 (@pxref{absolute}), patterns and names are used as-is. For
7426 example, trailing @samp{/} is not trimmed from a user-specified name
7427 before deciding whether to exclude it.
7429 However, this matching procedure can be altered by the options listed
7430 below. These options accumulate. For example:
7433 --ignore-case --exclude='makefile' --no-ignore-case ---exclude='readme'
7437 ignores case when excluding @samp{makefile}, but not when excluding
7442 @opindex no-anchored
7444 @itemx --no-anchored
7445 If anchored, a pattern must match an initial subsequence
7446 of the name's components. Otherwise, the pattern can match any
7447 subsequence. Default is @option{--no-anchored} for exclusion members
7448 and @option{--anchored} inclusion members.
7450 @opindex ignore-case
7451 @opindex no-ignore-case
7453 @itemx --no-ignore-case
7454 When ignoring case, upper-case patterns match lower-case names and vice versa.
7455 When not ignoring case (the default), matching is case-sensitive.
7457 @opindex wildcards-match-slash
7458 @opindex no-wildcards-match-slash
7459 @item --wildcards-match-slash
7460 @itemx --no-wildcards-match-slash
7461 When wildcards match slash (the default for exclusion members), a
7462 wildcard like @samp{*} in the pattern can match a @samp{/} in the
7463 name. Otherwise, @samp{/} is matched only by @samp{/}.
7467 The @option{--recursion} and @option{--no-recursion} options
7468 (@pxref{recurse}) also affect how member patterns are interpreted. If
7469 recursion is in effect, a pattern matches a name if it matches any of
7470 the name's parent directories.
7472 The following table summarizes pattern-matching default values:
7474 @multitable @columnfractions .3 .7
7475 @headitem Members @tab Default settings
7476 @item Inclusion @tab @option{--no-wildcards --anchored --no-wildcards-match-slash}
7477 @item Exclusion @tab @option{--wildcards --no-anchored --wildcards-match-slash}
7480 @node quoting styles
7481 @section Quoting Member Names
7483 When displaying member names, @command{tar} takes care to avoid
7484 ambiguities caused by certain characters. This is called @dfn{name
7485 quoting}. The characters in question are:
7488 @item Non-printable control characters:
7489 @anchor{escape sequences}
7490 @multitable @columnfractions 0.20 0.10 0.60
7491 @headitem Character @tab @acronym{ASCII} @tab Character name
7492 @item \a @tab 7 @tab Audible bell
7493 @item \b @tab 8 @tab Backspace
7494 @item \f @tab 12 @tab Form feed
7495 @item \n @tab 10 @tab New line
7496 @item \r @tab 13 @tab Carriage return
7497 @item \t @tab 9 @tab Horizontal tabulation
7498 @item \v @tab 11 @tab Vertical tabulation
7501 @item Space (@acronym{ASCII} 32)
7503 @item Single and double quotes (@samp{'} and @samp{"})
7505 @item Backslash (@samp{\})
7508 The exact way @command{tar} uses to quote these characters depends on
7509 the @dfn{quoting style}. The default quoting style, called
7510 @dfn{escape} (see below), uses backslash notation to represent control
7511 characters, space and backslash. Using this quoting style, control
7512 characters are represented as listed in column @samp{Character} in the
7513 above table, a space is printed as @samp{\ } and a backslash as @samp{\\}.
7515 @GNUTAR{} offers seven distinct quoting styles, which can be selected
7516 using @option{--quoting-style} option:
7519 @item --quoting-style=@var{style}
7520 @opindex quoting-style
7522 Sets quoting style. Valid values for @var{style} argument are:
7523 literal, shell, shell-always, c, escape, locale, clocale.
7526 These styles are described in detail below. To illustrate their
7527 effect, we will use an imaginary tar archive @file{arch.tar}
7528 containing the following members:
7532 # 1. Contains horizontal tabulation character.
7534 # 2. Contains newline character
7537 # 3. Contains a space
7539 # 4. Contains double quotes
7541 # 5. Contains single quotes
7543 # 6. Contains a backslash character:
7548 Here is how usual @command{ls} command would have listed them, if they
7549 had existed in the current working directory:
7567 No quoting, display each character as is:
7571 $ @kbd{tar tf arch.tar --quoting-style=literal}
7584 Display characters the same way Bourne shell does:
7585 control characters, except @samp{\t} and @samp{\n}, are printed using
7586 backslash escapes, @samp{\t} and @samp{\n} are printed as is, and a
7587 single quote is printed as @samp{\'}. If a name contains any quoted
7588 characters, it is enclosed in single quotes. In particular, if a name
7589 contains single quotes, it is printed as several single-quoted strings:
7593 $ @kbd{tar tf arch.tar --quoting-style=shell}
7596 './a'\''single'\''quote'
7606 Same as @samp{shell}, but the names are always enclosed in single
7611 $ @kbd{tar tf arch.tar --quoting-style=shell-always}
7614 './a'\''single'\''quote'
7624 Use the notation of the C programming language. All names are
7625 enclosed in double quotes. Control characters are quoted using
7626 backslash notations, double quotes are represented as @samp{\"},
7627 backslash characters are represented as @samp{\\}. Single quotes and
7628 spaces are not quoted:
7632 $ @kbd{tar tf arch.tar --quoting-style=c}
7636 "./a\"double\"quote"
7644 Control characters are printed using backslash notation, a space is
7645 printed as @samp{\ } and a backslash as @samp{\\}. This is the
7646 default quoting style, unless it was changed when configured the
7651 $ @kbd{tar tf arch.tar --quoting-style=escape}
7663 Control characters, single quote and backslash are printed using
7664 backslash notation. All names are quoted using left and right
7665 quotation marks, appropriate to the current locale. If it does not
7666 define quotation marks, use @samp{`} as left and @samp{'} as right
7667 quotation marks. Any occurrences of the right quotation mark in a
7668 name are escaped with @samp{\}, for example:
7674 $ @kbd{tar tf arch.tar --quoting-style=locale}
7677 `./a\'single\'quote'
7686 Same as @samp{locale}, but @samp{"} is used for both left and right
7687 quotation marks, if not provided by the currently selected locale:
7691 $ @kbd{tar tf arch.tar --quoting-style=clocale}
7695 "./a\"double\"quote"
7703 You can specify which characters should be quoted in addition to those
7704 implied by the current quoting style:
7707 @item --quote-chars=@var{string}
7708 Always quote characters from @var{string}, even if the selected
7709 quoting style would not quote them.
7712 For example, using @samp{escape} quoting (compare with the usual
7713 escape listing above):
7717 $ @kbd{tar tf arch.tar --quoting-style=escape --quote-chars=' "'}
7728 To disable quoting of such additional characters, use the following
7732 @item --no-quote-chars=@var{string}
7733 Remove characters listed in @var{string} from the list of quoted
7734 characters set by the previous @option{--quote-chars} option.
7737 This option is particularly useful if you have added
7738 @option{--quote-chars} to your @env{TAR_OPTIONS} (@pxref{TAR_OPTIONS})
7739 and wish to disable it for the current invocation.
7741 Note, that @option{--no-quote-chars} does @emph{not} disable those
7742 characters that are quoted by default in the selected quoting style.
7745 @section Modifying File and Member Names
7747 @command{Tar} archives contain detailed information about files stored
7748 in them and full file names are part of that information. When
7749 storing file to an archive, its file name is recorded in it,
7750 along with the actual file contents. When restoring from an archive,
7751 a file is created on disk with exactly the same name as that stored
7752 in the archive. In the majority of cases this is the desired behavior
7753 of a file archiver. However, there are some cases when it is not.
7755 First of all, it is often unsafe to extract archive members with
7756 absolute file names or those that begin with a @file{../}. @GNUTAR{}
7757 takes special precautions when extracting such names and provides a
7758 special option for handling them, which is described in
7761 Secondly, you may wish to extract file names without some leading
7762 directory components, or with otherwise modified names. In other
7763 cases it is desirable to store files under differing names in the
7766 @GNUTAR{} provides several options for these needs.
7769 @opindex strip-components
7770 @item --strip-components=@var{number}
7771 Strip given @var{number} of leading components from file names before
7775 For example, suppose you have archived whole @file{/usr} hierarchy to
7776 a tar archive named @file{usr.tar}. Among other files, this archive
7777 contains @file{usr/include/stdlib.h}, which you wish to extract to
7778 the current working directory. To do so, you type:
7781 $ @kbd{tar -xf usr.tar --strip=2 usr/include/stdlib.h}
7784 The option @option{--strip=2} instructs @command{tar} to strip the
7785 two leading components (@file{usr/} and @file{include/}) off the file
7788 If you add the @option{--verbose} (@option{-v}) option to the invocation
7789 above, you will note that the verbose listing still contains the
7790 full file name, with the two removed components still in place. This
7791 can be inconvenient, so @command{tar} provides a special option for
7792 altering this behavior:
7794 @anchor{show-transformed-names}
7796 @opindex show-transformed-names
7797 @item --show-transformed-names
7798 Display file or member names with all requested transformations
7807 $ @kbd{tar -xf usr.tar -v --strip=2 usr/include/stdlib.h}
7808 usr/include/stdlib.h
7809 $ @kbd{tar -xf usr.tar -v --strip=2 --show-transformed usr/include/stdlib.h}
7814 Notice that in both cases the file @file{stdlib.h} is extracted to the
7815 current working directory, @option{--show-transformed-names} affects
7816 only the way its name is displayed.
7818 This option is especially useful for verifying whether the invocation
7819 will have the desired effect. Thus, before running
7822 $ @kbd{tar -x --strip=@var{n}}
7826 it is often advisable to run
7829 $ @kbd{tar -t -v --show-transformed --strip=@var{n}}
7833 to make sure the command will produce the intended results.
7835 In case you need to apply more complex modifications to the file name,
7836 @GNUTAR{} provides a general-purpose transformation option:
7841 @item --transform=@var{expression}
7842 @itemx --xform=@var{expression}
7843 Modify file names using supplied @var{expression}.
7847 The @var{expression} is a @command{sed}-like replace expression of the
7851 s/@var{regexp}/@var{replace}/[@var{flags}]
7855 where @var{regexp} is a @dfn{regular expression}, @var{replace} is a
7856 replacement for each file name part that matches @var{regexp}. Both
7857 @var{regexp} and @var{replace} are described in detail in
7858 @ref{The "s" Command, The "s" Command, The `s' Command, sed, GNU sed}.
7860 Any delimiter can be used in lieue of @samp{/}, the only requirement being
7861 that it be used consistently throughout the expression. For example,
7862 the following two expressions are equivalent:
7871 Changing delimiters is often useful when the @var{regex} contains
7872 slashes. For example, it is more convenient to write @code{s,/,-,} than
7875 As in @command{sed}, you can give several replace expressions,
7876 separated by a semicolon.
7878 Supported @var{flags} are:
7882 Apply the replacement to @emph{all} matches to the @var{regexp}, not
7886 Use case-insensitive matching
7889 @var{regexp} is an @dfn{extended regular expression} (@pxref{Extended
7890 regexps, Extended regular expressions, Extended regular expressions,
7894 Only replace the @var{number}th match of the @var{regexp}.
7896 Note: the @acronym{POSIX} standard does not specify what should happen
7897 when you mix the @samp{g} and @var{number} modifiers. @GNUTAR{}
7898 follows the GNU @command{sed} implementation in this regard, so
7899 the interaction is defined to be: ignore matches before the
7900 @var{number}th, and then match and replace all matches from the
7905 In addition, several @dfn{transformation scope} flags are supported,
7906 that control to what files transformations apply. These are:
7910 Apply transformation to regular archive members.
7913 Do not apply transformation to regular archive members.
7916 Apply transformation to symbolic link targets.
7919 Do not apply transformation to symbolic link targets.
7922 Apply transformation to hard link targets.
7925 Do not apply transformation to hard link targets.
7928 Default is @samp{rsh}, which means to apply tranformations to both archive
7929 members and targets of symbolic and hard links.
7931 Default scope flags can also be changed using @samp{flags=} statement
7932 in the transform expression. The flags set this way remain in force
7933 until next @samp{flags=} statement or end of expression, whichever
7934 occurs first. For example:
7937 --transform 'flags=S;s|^|/usr/local/|'
7940 Here are several examples of @option{--transform} usage:
7943 @item Extract @file{usr/} hierarchy into @file{usr/local/}:
7946 $ @kbd{tar --transform='s,usr/,usr/local/,' -x -f arch.tar}
7949 @item Strip two leading directory components (equivalent to
7950 @option{--strip-components=2}):
7953 $ @kbd{tar --transform='s,/*[^/]*/[^/]*/,,' -x -f arch.tar}
7956 @item Convert each file name to lower case:
7959 $ @kbd{tar --transform 's/.*/\L&/' -x -f arch.tar}
7962 @item Prepend @file{/prefix/} to each file name:
7965 $ @kbd{tar --transform 's,^,/prefix/,' -x -f arch.tar}
7968 @item Archive the @file{/lib} directory, prepending @samp{/usr/local}
7969 to each archive member:
7972 $ @kbd{tar --transform 's,^,/usr/local/,S' -c -f arch.tar /lib}
7976 Notice the use of flags in the last example. The @file{/lib}
7977 directory often contains many symbolic links to files within it.
7978 It may look, for example, like this:
7982 drwxr-xr-x root/root 0 2008-07-08 16:20 /lib/
7983 -rwxr-xr-x root/root 1250840 2008-05-25 07:44 /lib/libc-2.3.2.so
7984 lrwxrwxrwx root/root 0 2008-06-24 17:12 /lib/libc.so.6 -> libc-2.3.2.so
7988 Using the expression @samp{s,^,/usr/local/,} would mean adding
7989 @samp{/usr/local} to both regular archive members and to link
7990 targets. In this case, @file{/lib/libc.so.6} would become:
7993 /usr/local/lib/libc.so.6 -> /usr/local/libc-2.3.2.so
7996 This is definitely not desired. To avoid this, the @samp{S} flag
7997 are used, which excludes symbolic link targets from filename
7998 transformations. The result is:
8001 $ @kbd{tar --transform 's,^,/usr/local/,S', -c -v -f arch.tar \
8002 --show-transformed /lib}
8003 drwxr-xr-x root/root 0 2008-07-08 16:20 /usr/local/lib/
8004 -rwxr-xr-x root/root 1250840 2008-05-25 07:44 /usr/local/lib/libc-2.3.2.so
8005 lrwxrwxrwx root/root 0 2008-06-24 17:12 /usr/local/lib/libc.so.6 ->
8009 Unlike @option{--strip-components}, @option{--transform} can be used
8010 in any @GNUTAR{} operation mode. For example, the following command
8011 adds files to the archive while replacing the leading @file{usr/}
8012 component with @file{var/}:
8015 $ @kbd{tar -cf arch.tar --transform='s,^usr/,var/,' /}
8018 To test @option{--transform} effect we suggest using
8019 @option{--show-transformed-names} option:
8022 $ @kbd{tar -cf arch.tar --transform='s,^usr/,var/,' \
8023 --verbose --show-transformed-names /}
8026 If both @option{--strip-components} and @option{--transform} are used
8027 together, then @option{--transform} is applied first, and the required
8028 number of components is then stripped from its result.
8030 You can use as many @option{--transform} options in a single command
8031 line as you want. The specified expressions will then be applied in
8032 order of their appearance. For example, the following two invocations
8036 $ @kbd{tar -cf arch.tar --transform='s,/usr/var,/var/' \
8037 --transform='s,/usr/local,/usr/,'}
8038 $ @kbd{tar -cf arch.tar \
8039 --transform='s,/usr/var,/var/;s,/usr/local,/usr/,'}
8043 @section Operating Only on New Files
8045 @cindex Excluding file by age
8046 @cindex Data Modification time, excluding files by
8047 @cindex Modification time, excluding files by
8048 @cindex Age, excluding files by
8049 The @option{--after-date=@var{date}} (@option{--newer=@var{date}},
8050 @option{-N @var{date}}) option causes @command{tar} to only work on
8051 files whose data modification or status change times are newer than
8052 the @var{date} given. If @var{date} starts with @samp{/} or @samp{.},
8053 it is taken to be a file name; the data modification time of that file
8054 is used as the date. If you use this option when creating or appending
8055 to an archive, the archive will only include new files. If you use
8056 @option{--after-date} when extracting an archive, @command{tar} will
8057 only extract files newer than the @var{date} you specify.
8059 If you only want @command{tar} to make the date comparison based on
8060 modification of the file's data (rather than status
8061 changes), then use the @option{--newer-mtime=@var{date}} option.
8063 @cindex --after-date and --update compared
8064 @cindex --newer-mtime and --update compared
8065 You may use these options with any operation. Note that these options
8066 differ from the @option{--update} (@option{-u}) operation in that they
8067 allow you to specify a particular date against which @command{tar} can
8068 compare when deciding whether or not to archive the files.
8073 @item --after-date=@var{date}
8074 @itemx --newer=@var{date}
8075 @itemx -N @var{date}
8076 Only store files newer than @var{date}.
8078 Acts on files only if their data modification or status change times are
8079 later than @var{date}. Use in conjunction with any operation.
8081 If @var{date} starts with @samp{/} or @samp{.}, it is taken to be a file
8082 name; the data modification time of that file is used as the date.
8084 @opindex newer-mtime
8085 @item --newer-mtime=@var{date}
8086 Acts like @option{--after-date}, but only looks at data modification times.
8089 These options limit @command{tar} to operate only on files which have
8090 been modified after the date specified. A file's status is considered to have
8091 changed if its contents have been modified, or if its owner,
8092 permissions, and so forth, have been changed. (For more information on
8093 how to specify a date, see @ref{Date input formats}; remember that the
8094 entire date argument must be quoted if it contains any spaces.)
8096 Gurus would say that @option{--after-date} tests both the data
8097 modification time (@code{mtime}, the time the contents of the file
8098 were last modified) and the status change time (@code{ctime}, the time
8099 the file's status was last changed: owner, permissions, etc.@:)
8100 fields, while @option{--newer-mtime} tests only the @code{mtime}
8103 To be precise, @option{--after-date} checks @emph{both} @code{mtime} and
8104 @code{ctime} and processes the file if either one is more recent than
8105 @var{date}, while @option{--newer-mtime} only checks @code{mtime} and
8106 disregards @code{ctime}. Neither does it use @code{atime} (the last time the
8107 contents of the file were looked at).
8109 Date specifiers can have embedded spaces. Because of this, you may need
8110 to quote date arguments to keep the shell from parsing them as separate
8111 arguments. For example, the following command will add to the archive
8112 all the files modified less than two days ago:
8115 $ @kbd{tar -cf foo.tar --newer-mtime '2 days ago'}
8118 When any of these options is used with the option @option{--verbose}
8119 (@pxref{verbose tutorial}) @GNUTAR{} will try to convert the specified
8120 date back to its textual representation and compare that with the
8121 one given with the option. If the two dates differ, @command{tar} will
8122 print a warning saying what date it will use. This is to help user
8123 ensure he is using the right date. For example:
8127 $ @kbd{tar -c -f archive.tar --after-date='10 days ago' .}
8128 tar: Option --after-date: Treating date `10 days ago' as 2006-06-11
8134 @strong{Please Note:} @option{--after-date} and @option{--newer-mtime}
8135 should not be used for incremental backups. @xref{Incremental Dumps},
8136 for proper way of creating incremental backups.
8140 @section Descending into Directories
8141 @cindex Avoiding recursion in directories
8142 @cindex Descending directories, avoiding
8143 @cindex Directories, avoiding recursion
8144 @cindex Recursion in directories, avoiding
8146 Usually, @command{tar} will recursively explore all directories (either
8147 those given on the command line or through the @option{--files-from}
8148 option) for the various files they contain. However, you may not always
8149 want @command{tar} to act this way.
8151 @opindex no-recursion
8152 @cindex @command{find}, using with @command{tar}
8153 The @option{--no-recursion} option inhibits @command{tar}'s recursive descent
8154 into specified directories. If you specify @option{--no-recursion}, you can
8155 use the @command{find} (@pxref{Top,, find, find, GNU Find Manual})
8156 utility for hunting through levels of directories to
8157 construct a list of file names which you could then pass to @command{tar}.
8158 @command{find} allows you to be more selective when choosing which files to
8159 archive; see @ref{files}, for more information on using @command{find} with
8163 @item --no-recursion
8164 Prevents @command{tar} from recursively descending directories.
8168 Requires @command{tar} to recursively descend directories.
8169 This is the default.
8172 When you use @option{--no-recursion}, @GNUTAR{} grabs
8173 directory entries themselves, but does not descend on them
8174 recursively. Many people use @command{find} for locating files they
8175 want to back up, and since @command{tar} @emph{usually} recursively
8176 descends on directories, they have to use the @samp{@w{-not -type d}}
8177 test in their @command{find} invocation (@pxref{Type, Type, Type test,
8178 find, Finding Files}), as they usually do not want all the files in a
8179 directory. They then use the @option{--files-from} option to archive
8180 the files located via @command{find}.
8182 The problem when restoring files archived in this manner is that the
8183 directories themselves are not in the archive; so the
8184 @option{--same-permissions} (@option{--preserve-permissions},
8185 @option{-p}) option does not affect them---while users might really
8186 like it to. Specifying @option{--no-recursion} is a way to tell
8187 @command{tar} to grab only the directory entries given to it, adding
8188 no new files on its own. To summarize, if you use @command{find} to
8189 create a list of files to be stored in an archive, use it as follows:
8193 $ @kbd{find @var{dir} @var{tests} | \
8194 tar -cf @var{archive} -T - --no-recursion}
8198 The @option{--no-recursion} option also applies when extracting: it
8199 causes @command{tar} to extract only the matched directory entries, not
8200 the files under those directories.
8202 The @option{--no-recursion} option also affects how globbing patterns
8203 are interpreted (@pxref{controlling pattern-matching}).
8205 The @option{--no-recursion} and @option{--recursion} options apply to
8206 later options and operands, and can be overridden by later occurrences
8207 of @option{--no-recursion} and @option{--recursion}. For example:
8210 $ @kbd{tar -cf jams.tar --no-recursion grape --recursion grape/concord}
8214 creates an archive with one entry for @file{grape}, and the recursive
8215 contents of @file{grape/concord}, but no entries under @file{grape}
8216 other than @file{grape/concord}.
8219 @section Crossing File System Boundaries
8220 @cindex File system boundaries, not crossing
8222 @command{tar} will normally automatically cross file system boundaries in
8223 order to archive files which are part of a directory tree. You can
8224 change this behavior by running @command{tar} and specifying
8225 @option{--one-file-system}. This option only affects files that are
8226 archived because they are in a directory that is being archived;
8227 @command{tar} will still archive files explicitly named on the command line
8228 or through @option{--files-from}, regardless of where they reside.
8231 @opindex one-file-system
8232 @item --one-file-system
8233 Prevents @command{tar} from crossing file system boundaries when
8234 archiving. Use in conjunction with any write operation.
8237 The @option{--one-file-system} option causes @command{tar} to modify its
8238 normal behavior in archiving the contents of directories. If a file in
8239 a directory is not on the same file system as the directory itself, then
8240 @command{tar} will not archive that file. If the file is a directory
8241 itself, @command{tar} will not archive anything beneath it; in other words,
8242 @command{tar} will not cross mount points.
8244 This option is useful for making full or incremental archival backups of
8245 a file system. If this option is used in conjunction with
8246 @option{--verbose} (@option{-v}), files that are excluded are
8247 mentioned by name on the standard error.
8250 * directory:: Changing Directory
8251 * absolute:: Absolute File Names
8255 @subsection Changing the Working Directory
8257 @FIXME{need to read over this node now for continuity; i've switched
8258 things around some.}
8260 @cindex Changing directory mid-stream
8261 @cindex Directory, changing mid-stream
8262 @cindex Working directory, specifying
8263 To change the working directory in the middle of a list of file names,
8264 either on the command line or in a file specified using
8265 @option{--files-from} (@option{-T}), use @option{--directory} (@option{-C}).
8266 This will change the working directory to the specified directory
8267 after that point in the list.
8271 @item --directory=@var{directory}
8272 @itemx -C @var{directory}
8273 Changes the working directory in the middle of a command line.
8279 $ @kbd{tar -c -f jams.tar grape prune -C food cherry}
8283 will place the files @file{grape} and @file{prune} from the current
8284 directory into the archive @file{jams.tar}, followed by the file
8285 @file{cherry} from the directory @file{food}. This option is especially
8286 useful when you have several widely separated files that you want to
8287 store in the same archive.
8289 Note that the file @file{cherry} is recorded in the archive under the
8290 precise name @file{cherry}, @emph{not} @file{food/cherry}. Thus, the
8291 archive will contain three files that all appear to have come from the
8292 same directory; if the archive is extracted with plain @samp{tar
8293 --extract}, all three files will be written in the current directory.
8295 Contrast this with the command,
8298 $ @kbd{tar -c -f jams.tar grape prune -C food red/cherry}
8302 which records the third file in the archive under the name
8303 @file{red/cherry} so that, if the archive is extracted using
8304 @samp{tar --extract}, the third file will be written in a subdirectory
8305 named @file{orange-colored}.
8307 You can use the @option{--directory} option to make the archive
8308 independent of the original name of the directory holding the files.
8309 The following command places the files @file{/etc/passwd},
8310 @file{/etc/hosts}, and @file{/lib/libc.a} into the archive
8314 $ @kbd{tar -c -f foo.tar -C /etc passwd hosts -C /lib libc.a}
8318 However, the names of the archive members will be exactly what they were
8319 on the command line: @file{passwd}, @file{hosts}, and @file{libc.a}.
8320 They will not appear to be related by file name to the original
8321 directories where those files were located.
8323 Note that @option{--directory} options are interpreted consecutively. If
8324 @option{--directory} specifies a relative file name, it is interpreted
8325 relative to the then current directory, which might not be the same as
8326 the original current working directory of @command{tar}, due to a previous
8327 @option{--directory} option.
8329 When using @option{--files-from} (@pxref{files}), you can put various
8330 @command{tar} options (including @option{-C}) in the file list. Notice,
8331 however, that in this case the option and its argument may not be
8332 separated by whitespace. If you use short option, its argument must
8333 either follow the option letter immediately, without any intervening
8334 whitespace, or occupy the next line. Otherwise, if you use long
8335 option, separate its argument by an equal sign.
8337 For instance, the file list for the above example will be:
8350 To use it, you would invoke @command{tar} as follows:
8353 $ @kbd{tar -c -f foo.tar --files-from list}
8356 The interpretation of @option{--directory} is disabled by
8357 @option{--null} option.
8360 @subsection Absolute File Names
8361 @cindex absolute file names
8362 @cindex file names, absolute
8364 By default, @GNUTAR{} drops a leading @samp{/} on
8365 input or output, and complains about file names containing a @file{..}
8366 component. There is an option that turns off this behavior:
8369 @opindex absolute-names
8370 @item --absolute-names
8372 Do not strip leading slashes from file names, and permit file names
8373 containing a @file{..} file name component.
8376 When @command{tar} extracts archive members from an archive, it strips any
8377 leading slashes (@samp{/}) from the member name. This causes absolute
8378 member names in the archive to be treated as relative file names. This
8379 allows you to have such members extracted wherever you want, instead of
8380 being restricted to extracting the member in the exact directory named
8381 in the archive. For example, if the archive member has the name
8382 @file{/etc/passwd}, @command{tar} will extract it as if the name were
8383 really @file{etc/passwd}.
8385 File names containing @file{..} can cause problems when extracting, so
8386 @command{tar} normally warns you about such files when creating an
8387 archive, and rejects attempts to extracts such files.
8389 Other @command{tar} programs do not do this. As a result, if you
8390 create an archive whose member names start with a slash, they will be
8391 difficult for other people with a non-@GNUTAR{}
8392 program to use. Therefore, @GNUTAR{} also strips
8393 leading slashes from member names when putting members into the
8394 archive. For example, if you ask @command{tar} to add the file
8395 @file{/bin/ls} to an archive, it will do so, but the member name will
8396 be @file{bin/ls}.@footnote{A side effect of this is that when
8397 @option{--create} is used with @option{--verbose} the resulting output
8398 is not, generally speaking, the same as the one you'd get running
8399 @kbd{tar --list} command. This may be important if you use some
8400 scripts for comparing both outputs. @xref{listing member and file names},
8401 for the information on how to handle this case.}
8403 If you use the @option{--absolute-names} (@option{-P}) option,
8404 @command{tar} will do none of these transformations.
8406 To archive or extract files relative to the root directory, specify
8407 the @option{--absolute-names} (@option{-P}) option.
8409 Normally, @command{tar} acts on files relative to the working
8410 directory---ignoring superior directory names when archiving, and
8411 ignoring leading slashes when extracting.
8413 When you specify @option{--absolute-names} (@option{-P}),
8414 @command{tar} stores file names including all superior directory
8415 names, and preserves leading slashes. If you only invoked
8416 @command{tar} from the root directory you would never need the
8417 @option{--absolute-names} option, but using this option
8418 may be more convenient than switching to root.
8420 @FIXME{Should be an example in the tutorial/wizardry section using this
8421 to transfer files between systems.}
8424 @item --absolute-names
8425 Preserves full file names (including superior directory names) when
8426 archiving files. Preserves leading slash when extracting files.
8430 @command{tar} prints out a message about removing the @samp{/} from
8431 file names. This message appears once per @GNUTAR{}
8432 invocation. It represents something which ought to be told; ignoring
8433 what it means can cause very serious surprises, later.
8435 Some people, nevertheless, do not want to see this message. Wanting to
8436 play really dangerously, one may of course redirect @command{tar} standard
8437 error to the sink. For example, under @command{sh}:
8440 $ @kbd{tar -c -f archive.tar /home 2> /dev/null}
8444 Another solution, both nicer and simpler, would be to change to
8445 the @file{/} directory first, and then avoid absolute notation.
8449 $ @kbd{tar -c -f archive.tar -C / home}
8452 @include getdate.texi
8455 @chapter Controlling the Archive Format
8457 @cindex Tar archive formats
8458 Due to historical reasons, there are several formats of tar archives.
8459 All of them are based on the same principles, but have some subtle
8460 differences that often make them incompatible with each other.
8462 GNU tar is able to create and handle archives in a variety of formats.
8463 The most frequently used formats are (in alphabetical order):
8467 Format used by @GNUTAR{} versions up to 1.13.25. This format derived
8468 from an early @acronym{POSIX} standard, adding some improvements such as
8469 sparse file handling and incremental archives. Unfortunately these
8470 features were implemented in a way incompatible with other archive
8473 Archives in @samp{gnu} format are able to hold file names of unlimited
8477 Format used by @GNUTAR{} of versions prior to 1.12.
8480 Archive format, compatible with the V7 implementation of tar. This
8481 format imposes a number of limitations. The most important of them
8485 @item The maximum length of a file name is limited to 99 characters.
8486 @item The maximum length of a symbolic link is limited to 99 characters.
8487 @item It is impossible to store special files (block and character
8488 devices, fifos etc.)
8489 @item Maximum value of user or group @acronym{ID} is limited to 2097151 (7777777
8491 @item V7 archives do not contain symbolic ownership information (user
8492 and group name of the file owner).
8495 This format has traditionally been used by Automake when producing
8496 Makefiles. This practice will change in the future, in the meantime,
8497 however this means that projects containing file names more than 99
8498 characters long will not be able to use @GNUTAR{} @value{VERSION} and
8499 Automake prior to 1.9.
8502 Archive format defined by @acronym{POSIX.1-1988} specification. It stores
8503 symbolic ownership information. It is also able to store
8504 special files. However, it imposes several restrictions as well:
8507 @item The maximum length of a file name is limited to 256 characters,
8508 provided that the file name can be split at a directory separator in
8509 two parts, first of them being at most 155 bytes long. So, in most
8510 cases the maximum file name length will be shorter than 256
8512 @item The maximum length of a symbolic link name is limited to
8514 @item Maximum size of a file the archive is able to accommodate
8516 @item Maximum value of UID/GID is 2097151.
8517 @item Maximum number of bits in device major and minor numbers is 21.
8521 Format used by J@"org Schilling @command{star}
8522 implementation. @GNUTAR{} is able to read @samp{star} archives but
8523 currently does not produce them.
8526 Archive format defined by @acronym{POSIX.1-2001} specification. This is the
8527 most flexible and feature-rich format. It does not impose any
8528 restrictions on file sizes or file name lengths. This format is quite
8529 recent, so not all tar implementations are able to handle it properly.
8530 However, this format is designed in such a way that any tar
8531 implementation able to read @samp{ustar} archives will be able to read
8532 most @samp{posix} archives as well, with the only exception that any
8533 additional information (such as long file names etc.) will in such
8534 case be extracted as plain text files along with the files it refers to.
8536 This archive format will be the default format for future versions
8541 The following table summarizes the limitations of each of these
8544 @multitable @columnfractions .10 .20 .20 .20 .20
8545 @headitem Format @tab UID @tab File Size @tab File Name @tab Devn
8546 @item gnu @tab 1.8e19 @tab Unlimited @tab Unlimited @tab 63
8547 @item oldgnu @tab 1.8e19 @tab Unlimited @tab Unlimited @tab 63
8548 @item v7 @tab 2097151 @tab 8GB @tab 99 @tab n/a
8549 @item ustar @tab 2097151 @tab 8GB @tab 256 @tab 21
8550 @item posix @tab Unlimited @tab Unlimited @tab Unlimited @tab Unlimited
8553 The default format for @GNUTAR{} is defined at compilation
8554 time. You may check it by running @command{tar --help}, and examining
8555 the last lines of its output. Usually, @GNUTAR{} is configured
8556 to create archives in @samp{gnu} format, however, future version will
8557 switch to @samp{posix}.
8560 * Compression:: Using Less Space through Compression
8561 * Attributes:: Handling File Attributes
8562 * Portability:: Making @command{tar} Archives More Portable
8563 * cpio:: Comparison of @command{tar} and @command{cpio}
8567 @section Using Less Space through Compression
8570 * gzip:: Creating and Reading Compressed Archives
8571 * sparse:: Archiving Sparse Files
8575 @subsection Creating and Reading Compressed Archives
8576 @cindex Compressed archives
8577 @cindex Storing archives in compressed format
8584 @GNUTAR{} is able to create and read compressed archives. It supports
8585 @command{gzip}, @command{bzip2}, @command{lzma} and @command{lzop} compression
8586 programs. For backward compatibility, it also supports
8587 @command{compress} command, although we strongly recommend against
8588 using it, because it is by far less effective than other compression
8589 programs@footnote{It also had patent problems in the past.}.
8591 Creating a compressed archive is simple: you just specify a
8592 @dfn{compression option} along with the usual archive creation
8593 commands. The compression option is @option{-z} (@option{--gzip}) to
8594 create a @command{gzip} compressed archive, @option{-j}
8595 (@option{--bzip2}) to create a @command{bzip2} compressed archive,
8596 @option{-J} (@option{--xz}) to create an @asis{XZ} archive,
8597 @option{--lzma} to create an @asis{LZMA} compressed
8598 archive, @option{--lzop} to create an @asis{LSOP} archive, and
8599 @option{-Z} (@option{--compress}) to use @command{compress} program.
8603 $ @kbd{tar cfz archive.tar.gz .}
8606 You can also let @GNUTAR{} select the compression program basing on
8607 the suffix of the archive file name. This is done using
8608 @option{--auto-compress} (@option{-a}) command line option. For
8609 example, the following invocation will use @command{bzip2} for
8613 $ @kbd{tar cfa archive.tar.bz2 .}
8617 whereas the following one will use @command{lzma}:
8620 $ @kbd{tar cfa archive.tar.lzma .}
8623 For a complete list of file name suffixes recognized by @GNUTAR{},
8624 @ref{auto-compress}.
8626 Reading compressed archive is even simpler: you don't need to specify
8627 any additional options as @GNUTAR{} recognizes its format
8628 automatically. Thus, the following commands will list and extract the
8629 archive created in previous example:
8632 # List the compressed archive
8633 $ @kbd{tar tf archive.tar.gz}
8634 # Extract the compressed archive
8635 $ @kbd{tar xf archive.tar.gz}
8638 The format recognition algorithm is based on @dfn{signatures}, a
8639 special byte sequences in the beginning of file, that are specific for
8640 certain compression formats. If this approach fails, @command{tar}
8641 falls back to using archive name suffix to determine its format
8642 (@xref{auto-compress}, for a list of recognized suffixes).
8644 The only case when you have to specify a decompression option while
8645 reading the archive is when reading from a pipe or from a tape drive
8646 that does not support random access. However, in this case @GNUTAR{}
8647 will indicate which option you should use. For example:
8650 $ @kbd{cat archive.tar.gz | tar tf -}
8651 tar: Archive is compressed. Use -z option
8652 tar: Error is not recoverable: exiting now
8655 If you see such diagnostics, just add the suggested option to the
8656 invocation of @GNUTAR{}:
8659 $ @kbd{cat archive.tar.gz | tar tfz -}
8662 Notice also, that there are several restrictions on operations on
8663 compressed archives. First of all, compressed archives cannot be
8664 modified, i.e., you cannot update (@option{--update} (@option{-u}))
8665 them or delete (@option{--delete}) members from them or
8666 add (@option{--append} (@option{-r})) members to them. Likewise, you
8667 cannot append another @command{tar} archive to a compressed archive using
8668 @option{--concatenate} (@option{-A})). Secondly, multi-volume
8669 archives cannot be compressed.
8671 The following table summarizes compression options used by @GNUTAR{}.
8674 @anchor{auto-compress}
8675 @opindex auto-compress
8676 @item --auto-compress
8678 Select a compression program to use by the archive file name
8679 suffix. The following suffixes are recognized:
8681 @multitable @columnfractions 0.3 0.6
8682 @headitem Suffix @tab Compression program
8683 @item @samp{.gz} @tab @command{gzip}
8684 @item @samp{.tgz} @tab @command{gzip}
8685 @item @samp{.taz} @tab @command{gzip}
8686 @item @samp{.Z} @tab @command{compress}
8687 @item @samp{.taZ} @tab @command{compress}
8688 @item @samp{.bz2} @tab @command{bzip2}
8689 @item @samp{.tz2} @tab @command{bzip2}
8690 @item @samp{.tbz2} @tab @command{bzip2}
8691 @item @samp{.tbz} @tab @command{bzip2}
8692 @item @samp{.lzma} @tab @command{lzma}
8693 @item @samp{.tlz} @tab @command{lzma}
8694 @item @samp{.lzo} @tab @command{lzop}
8695 @item @samp{.xz} @tab @command{xz}
8703 Filter the archive through @command{gzip}.
8705 You can use @option{--gzip} and @option{--gunzip} on physical devices
8706 (tape drives, etc.) and remote files as well as on normal files; data
8707 to or from such devices or remote files is reblocked by another copy
8708 of the @command{tar} program to enforce the specified (or default) record
8709 size. The default compression parameters are used; if you need to
8710 override them, set @env{GZIP} environment variable, e.g.:
8713 $ @kbd{GZIP=--best tar cfz archive.tar.gz subdir}
8717 Another way would be to avoid the @option{--gzip} (@option{--gunzip}, @option{--ungzip}, @option{-z}) option and run
8718 @command{gzip} explicitly:
8721 $ @kbd{tar cf - subdir | gzip --best -c - > archive.tar.gz}
8724 @cindex corrupted archives
8725 About corrupted compressed archives: @command{gzip}'ed files have no
8726 redundancy, for maximum compression. The adaptive nature of the
8727 compression scheme means that the compression tables are implicitly
8728 spread all over the archive. If you lose a few blocks, the dynamic
8729 construction of the compression tables becomes unsynchronized, and there
8730 is little chance that you could recover later in the archive.
8732 There are pending suggestions for having a per-volume or per-file
8733 compression in @GNUTAR{}. This would allow for viewing the
8734 contents without decompression, and for resynchronizing decompression at
8735 every volume or file, in case of corrupted archives. Doing so, we might
8736 lose some compressibility. But this would have make recovering easier.
8737 So, there are pros and cons. We'll see!
8742 Filter the archive through @code{xz}. Otherwise like
8747 Filter the archive through @code{bzip2}. Otherwise like @option{--gzip}.
8751 Filter the archive through @command{lzma}. Otherwise like @option{--gzip}.
8755 Filter the archive through @command{lzop}. Otherwise like
8763 Filter the archive through @command{compress}. Otherwise like @option{--gzip}.
8765 @opindex use-compress-program
8766 @item --use-compress-program=@var{prog}
8767 @itemx -I=@var{prog}
8768 Use external compression program @var{prog}. Use this option if you
8769 have a compression program that @GNUTAR{} does not support. There
8770 are two requirements to which @var{prog} should comply:
8772 First, when called without options, it should read data from standard
8773 input, compress it and output it on standard output.
8775 Secondly, if called with @option{-d} argument, it should do exactly
8776 the opposite, i.e., read the compressed data from the standard input
8777 and produce uncompressed data on the standard output.
8780 @cindex gpg, using with tar
8781 @cindex gnupg, using with tar
8782 @cindex Using encrypted archives
8783 The @option{--use-compress-program} option, in particular, lets you
8784 implement your own filters, not necessarily dealing with
8785 compression/decompression. For example, suppose you wish to implement
8786 PGP encryption on top of compression, using @command{gpg} (@pxref{Top,
8787 gpg, gpg ---- encryption and signing tool, gpg, GNU Privacy Guard
8788 Manual}). The following script does that:
8794 -d) gpg --decrypt - | gzip -d -c;;
8795 '') gzip -c | gpg -s ;;
8796 *) echo "Unknown option $1">&2; exit 1;;
8801 Suppose you name it @file{gpgz} and save it somewhere in your
8802 @env{PATH}. Then the following command will create a compressed
8803 archive signed with your private key:
8806 $ @kbd{tar -cf foo.tar.gpgz -Igpgz .}
8810 Likewise, the command below will list its contents:
8813 $ @kbd{tar -tf foo.tar.gpgz -Igpgz .}
8817 The above is based on the following discussion:
8819 I have one question, or maybe it's a suggestion if there isn't a way
8820 to do it now. I would like to use @option{--gzip}, but I'd also like
8821 the output to be fed through a program like @acronym{GNU}
8822 @command{ecc} (actually, right now that's @samp{exactly} what I'd like
8823 to use :-)), basically adding ECC protection on top of compression.
8824 It seems as if this should be quite easy to do, but I can't work out
8825 exactly how to go about it. Of course, I can pipe the standard output
8826 of @command{tar} through @command{ecc}, but then I lose (though I
8827 haven't started using it yet, I confess) the ability to have
8828 @command{tar} use @command{rmt} for it's I/O (I think).
8830 I think the most straightforward thing would be to let me specify a
8831 general set of filters outboard of compression (preferably ordered,
8832 so the order can be automatically reversed on input operations, and
8833 with the options they require specifiable), but beggars shouldn't be
8834 choosers and anything you decide on would be fine with me.
8836 By the way, I like @command{ecc} but if (as the comments say) it can't
8837 deal with loss of block sync, I'm tempted to throw some time at adding
8838 that capability. Supposing I were to actually do such a thing and
8839 get it (apparently) working, do you accept contributed changes to
8840 utilities like that? (Leigh Clayton @file{loc@@soliton.com}, May 1995).
8842 Isn't that exactly the role of the
8843 @option{--use-compress-prog=@var{program}} option?
8844 I never tried it myself, but I suspect you may want to write a
8845 @var{prog} script or program able to filter stdin to stdout to
8846 way you want. It should recognize the @option{-d} option, for when
8847 extraction is needed rather than creation.
8849 It has been reported that if one writes compressed data (through the
8850 @option{--gzip} or @option{--compress} options) to a DLT and tries to use
8851 the DLT compression mode, the data will actually get bigger and one will
8852 end up with less space on the tape.
8856 @subsection Archiving Sparse Files
8857 @cindex Sparse Files
8859 Files in the file system occasionally have @dfn{holes}. A @dfn{hole}
8860 in a file is a section of the file's contents which was never written.
8861 The contents of a hole reads as all zeros. On many operating systems,
8862 actual disk storage is not allocated for holes, but they are counted
8863 in the length of the file. If you archive such a file, @command{tar}
8864 could create an archive longer than the original. To have @command{tar}
8865 attempt to recognize the holes in a file, use @option{--sparse}
8866 (@option{-S}). When you use this option, then, for any file using
8867 less disk space than would be expected from its length, @command{tar}
8868 searches the file for consecutive stretches of zeros. It then records
8869 in the archive for the file where the consecutive stretches of zeros
8870 are, and only archives the ``real contents'' of the file. On
8871 extraction (using @option{--sparse} is not needed on extraction) any
8872 such files have holes created wherever the continuous stretches of zeros
8873 were found. Thus, if you use @option{--sparse}, @command{tar} archives
8874 won't take more space than the original.
8880 This option instructs @command{tar} to test each file for sparseness
8881 before attempting to archive it. If the file is found to be sparse it
8882 is treated specially, thus allowing to decrease the amount of space
8883 used by its image in the archive.
8885 This option is meaningful only when creating or updating archives. It
8886 has no effect on extraction.
8889 Consider using @option{--sparse} when performing file system backups,
8890 to avoid archiving the expanded forms of files stored sparsely in the
8893 Even if your system has no sparse files currently, some may be
8894 created in the future. If you use @option{--sparse} while making file
8895 system backups as a matter of course, you can be assured the archive
8896 will never take more space on the media than the files take on disk
8897 (otherwise, archiving a disk filled with sparse files might take
8898 hundreds of tapes). @xref{Incremental Dumps}.
8900 However, be aware that @option{--sparse} option presents a serious
8901 drawback. Namely, in order to determine if the file is sparse
8902 @command{tar} has to read it before trying to archive it, so in total
8903 the file is read @strong{twice}. So, always bear in mind that the
8904 time needed to process all files with this option is roughly twice
8905 the time needed to archive them without it.
8906 @FIXME{A technical note:
8908 Programs like @command{dump} do not have to read the entire file; by
8909 examining the file system directly, they can determine in advance
8910 exactly where the holes are and thus avoid reading through them. The
8911 only data it need read are the actual allocated data blocks.
8912 @GNUTAR{} uses a more portable and straightforward
8913 archiving approach, it would be fairly difficult that it does
8914 otherwise. Elizabeth Zwicky writes to @file{comp.unix.internals}, on
8918 What I did say is that you cannot tell the difference between a hole and an
8919 equivalent number of nulls without reading raw blocks. @code{st_blocks} at
8920 best tells you how many holes there are; it doesn't tell you @emph{where}.
8921 Just as programs may, conceivably, care what @code{st_blocks} is (care
8922 to name one that does?), they may also care where the holes are (I have
8923 no examples of this one either, but it's equally imaginable).
8925 I conclude from this that good archivers are not portable. One can
8926 arguably conclude that if you want a portable program, you can in good
8927 conscience restore files with as many holes as possible, since you can't
8932 @cindex sparse formats, defined
8933 When using @samp{POSIX} archive format, @GNUTAR{} is able to store
8934 sparse files using in three distinct ways, called @dfn{sparse
8935 formats}. A sparse format is identified by its @dfn{number},
8936 consisting, as usual of two decimal numbers, delimited by a dot. By
8937 default, format @samp{1.0} is used. If, for some reason, you wish to
8938 use an earlier format, you can select it using
8939 @option{--sparse-version} option.
8942 @opindex sparse-version
8943 @item --sparse-version=@var{version}
8945 Select the format to store sparse files in. Valid @var{version} values
8946 are: @samp{0.0}, @samp{0.1} and @samp{1.0}. @xref{Sparse Formats},
8947 for a detailed description of each format.
8950 Using @option{--sparse-format} option implies @option{--sparse}.
8953 @section Handling File Attributes
8954 @cindex atrributes, files
8955 @cindex file attributes
8957 When @command{tar} reads files, it updates their access times. To
8958 avoid this, use the @option{--atime-preserve[=METHOD]} option, which can either
8959 reset the access time retroactively or avoid changing it in the first
8963 @opindex atime-preserve
8964 @item --atime-preserve
8965 @itemx --atime-preserve=replace
8966 @itemx --atime-preserve=system
8967 Preserve the access times of files that are read. This works only for
8968 files that you own, unless you have superuser privileges.
8970 @option{--atime-preserve=replace} works on most systems, but it also
8971 restores the data modification time and updates the status change
8972 time. Hence it doesn't interact with incremental dumps nicely
8973 (@pxref{Incremental Dumps}), and it can set access or data modification times
8974 incorrectly if other programs access the file while @command{tar} is
8977 @option{--atime-preserve=system} avoids changing the access time in
8978 the first place, if the operating system supports this.
8979 Unfortunately, this may or may not work on any given operating system
8980 or file system. If @command{tar} knows for sure it won't work, it
8981 complains right away.
8983 Currently @option{--atime-preserve} with no operand defaults to
8984 @option{--atime-preserve=replace}, but this is intended to change to
8985 @option{--atime-preserve=system} when the latter is better-supported.
8990 Do not extract data modification time.
8992 When this option is used, @command{tar} leaves the data modification times
8993 of the files it extracts as the times when the files were extracted,
8994 instead of setting it to the times recorded in the archive.
8996 This option is meaningless with @option{--list} (@option{-t}).
9000 Create extracted files with the same ownership they have in the
9003 This is the default behavior for the superuser,
9004 so this option is meaningful only for non-root users, when @command{tar}
9005 is executed on those systems able to give files away. This is
9006 considered as a security flaw by many people, at least because it
9007 makes quite difficult to correctly account users for the disk space
9008 they occupy. Also, the @code{suid} or @code{sgid} attributes of
9009 files are easily and silently lost when files are given away.
9011 When writing an archive, @command{tar} writes the user @acronym{ID} and user name
9012 separately. If it can't find a user name (because the user @acronym{ID} is not
9013 in @file{/etc/passwd}), then it does not write one. When restoring,
9014 it tries to look the name (if one was written) up in
9015 @file{/etc/passwd}. If it fails, then it uses the user @acronym{ID} stored in
9016 the archive instead.
9018 @opindex no-same-owner
9019 @item --no-same-owner
9021 Do not attempt to restore ownership when extracting. This is the
9022 default behavior for ordinary users, so this option has an effect
9023 only for the superuser.
9025 @opindex numeric-owner
9026 @item --numeric-owner
9027 The @option{--numeric-owner} option allows (ANSI) archives to be written
9028 without user/group name information or such information to be ignored
9029 when extracting. It effectively disables the generation and/or use
9030 of user/group name information. This option forces extraction using
9031 the numeric ids from the archive, ignoring the names.
9033 This is useful in certain circumstances, when restoring a backup from
9034 an emergency floppy with different passwd/group files for example.
9035 It is otherwise impossible to extract files with the right ownerships
9036 if the password file in use during the extraction does not match the
9037 one belonging to the file system(s) being extracted. This occurs,
9038 for example, if you are restoring your files after a major crash and
9039 had booted from an emergency floppy with no password file or put your
9040 disk into another machine to do the restore.
9042 The numeric ids are @emph{always} saved into @command{tar} archives.
9043 The identifying names are added at create time when provided by the
9044 system, unless @option{--old-archive} (@option{-o}) is used. Numeric ids could be
9045 used when moving archives between a collection of machines using
9046 a centralized management for attribution of numeric ids to users
9047 and groups. This is often made through using the NIS capabilities.
9049 When making a @command{tar} file for distribution to other sites, it
9050 is sometimes cleaner to use a single owner for all files in the
9051 distribution, and nicer to specify the write permission bits of the
9052 files as stored in the archive independently of their actual value on
9053 the file system. The way to prepare a clean distribution is usually
9054 to have some Makefile rule creating a directory, copying all needed
9055 files in that directory, then setting ownership and permissions as
9056 wanted (there are a lot of possible schemes), and only then making a
9057 @command{tar} archive out of this directory, before cleaning
9058 everything out. Of course, we could add a lot of options to
9059 @GNUTAR{} for fine tuning permissions and ownership.
9060 This is not the good way, I think. @GNUTAR{} is
9061 already crowded with options and moreover, the approach just explained
9062 gives you a great deal of control already.
9064 @xopindex{same-permissions, short description}
9065 @xopindex{preserve-permissions, short description}
9067 @itemx --same-permissions
9068 @itemx --preserve-permissions
9069 Extract all protection information.
9071 This option causes @command{tar} to set the modes (access permissions) of
9072 extracted files exactly as recorded in the archive. If this option
9073 is not used, the current @code{umask} setting limits the permissions
9074 on extracted files. This option is by default enabled when
9075 @command{tar} is executed by a superuser.
9078 This option is meaningless with @option{--list} (@option{-t}).
9082 Same as both @option{--same-permissions} and @option{--same-order}.
9084 This option is deprecated, and will be removed in @GNUTAR{} version 1.23.
9089 @section Making @command{tar} Archives More Portable
9091 Creating a @command{tar} archive on a particular system that is meant to be
9092 useful later on many other machines and with other versions of @command{tar}
9093 is more challenging than you might think. @command{tar} archive formats
9094 have been evolving since the first versions of Unix. Many such formats
9095 are around, and are not always compatible with each other. This section
9096 discusses a few problems, and gives some advice about making @command{tar}
9097 archives more portable.
9099 One golden rule is simplicity. For example, limit your @command{tar}
9100 archives to contain only regular files and directories, avoiding
9101 other kind of special files. Do not attempt to save sparse files or
9102 contiguous files as such. Let's discuss a few more problems, in turn.
9104 @FIXME{Discuss GNU extensions (incremental backups, multi-volume
9105 archives and archive labels) in GNU and PAX formats.}
9108 * Portable Names:: Portable Names
9109 * dereference:: Symbolic Links
9110 * hard links:: Hard Links
9111 * old:: Old V7 Archives
9112 * ustar:: Ustar Archives
9113 * gnu:: GNU and old GNU format archives.
9114 * posix:: @acronym{POSIX} archives
9115 * Checksumming:: Checksumming Problems
9116 * Large or Negative Values:: Large files, negative time stamps, etc.
9117 * Other Tars:: How to Extract GNU-Specific Data Using
9118 Other @command{tar} Implementations
9121 @node Portable Names
9122 @subsection Portable Names
9124 Use portable file and member names. A name is portable if it contains
9125 only @acronym{ASCII} letters and digits, @samp{/}, @samp{.}, @samp{_}, and
9126 @samp{-}; it cannot be empty, start with @samp{-} or @samp{//}, or
9127 contain @samp{/-}. Avoid deep directory nesting. For portability to
9128 old Unix hosts, limit your file name components to 14 characters or
9131 If you intend to have your @command{tar} archives to be read under
9132 MSDOS, you should not rely on case distinction for file names, and you
9133 might use the @acronym{GNU} @command{doschk} program for helping you
9134 further diagnosing illegal MSDOS names, which are even more limited
9138 @subsection Symbolic Links
9139 @cindex File names, using symbolic links
9140 @cindex Symbolic link as file name
9142 @opindex dereference
9143 Normally, when @command{tar} archives a symbolic link, it writes a
9144 block to the archive naming the target of the link. In that way, the
9145 @command{tar} archive is a faithful record of the file system contents.
9146 @option{--dereference} (@option{-h}) is used with @option{--create} (@option{-c}), and causes
9147 @command{tar} to archive the files symbolic links point to, instead of
9148 the links themselves. When this option is used, when @command{tar}
9149 encounters a symbolic link, it will archive the linked-to file,
9150 instead of simply recording the presence of a symbolic link.
9152 The name under which the file is stored in the file system is not
9153 recorded in the archive. To record both the symbolic link name and
9154 the file name in the system, archive the file under both names. If
9155 all links were recorded automatically by @command{tar}, an extracted file
9156 might be linked to a file name that no longer exists in the file
9159 If a linked-to file is encountered again by @command{tar} while creating
9160 the same archive, an entire second copy of it will be stored. (This
9161 @emph{might} be considered a bug.)
9163 So, for portable archives, do not archive symbolic links as such,
9164 and use @option{--dereference} (@option{-h}): many systems do not support
9165 symbolic links, and moreover, your distribution might be unusable if
9166 it contains unresolved symbolic links.
9169 @subsection Hard Links
9170 @cindex File names, using hard links
9171 @cindex hard links, dereferencing
9172 @cindex dereferencing hard links
9174 Normally, when @command{tar} archives a hard link, it writes a
9175 block to the archive naming the target of the link (a @samp{1} type
9176 block). In that way, the actual file contents is stored in file only
9177 once. For example, consider the following two files:
9182 -rw-r--r-- 2 gray staff 4 2007-10-30 15:11 one
9183 -rw-r--r-- 2 gray staff 4 2007-10-30 15:11 jeden
9187 Here, @file{jeden} is a link to @file{one}. When archiving this
9188 directory with a verbose level 2, you will get an output similar to
9192 $ tar cfvv ../archive.tar .
9193 drwxr-xr-x gray/staff 0 2007-10-30 15:13 ./
9194 -rw-r--r-- gray/staff 4 2007-10-30 15:11 ./jeden
9195 hrw-r--r-- gray/staff 0 2007-10-30 15:11 ./one link to ./jeden
9198 The last line shows that, instead of storing two copies of the file,
9199 @command{tar} stored it only once, under the name @file{jeden}, and
9200 stored file @file{one} as a hard link to this file.
9202 It may be important to know that all hard links to the given file are
9203 stored in the archive. For example, this may be necessary for exact
9204 reproduction of the file system. The following option does that:
9207 @xopindex{check-links, described}
9210 Check the number of links dumped for each processed file. If this
9211 number does not match the total number of hard links for the file, print
9215 For example, trying to archive only file @file{jeden} with this option
9216 produces the following diagnostics:
9219 $ tar -c -f ../archive.tar jeden
9220 tar: Missing links to `jeden'.
9223 Although creating special records for hard links helps keep a faithful
9224 record of the file system contents and makes archives more compact, it
9225 may present some difficulties when extracting individual members from
9226 the archive. For example, trying to extract file @file{one} from the
9227 archive created in previous examples produces, in the absense of file
9231 $ tar xf archive.tar ./one
9232 tar: ./one: Cannot hard link to `./jeden': No such file or directory
9233 tar: Error exit delayed from previous errors
9236 The reason for this behavior is that @command{tar} cannot seek back in
9237 the archive to the previous member (in this case, @file{one}), to
9238 extract it@footnote{There are plans to fix this in future releases.}.
9239 If you wish to avoid such problems at the cost of a bigger archive,
9240 use the following option:
9243 @xopindex{hard-dereference, described}
9244 @item --hard-dereference
9245 Dereference hard links and store the files they refer to.
9248 For example, trying this option on our two sample files, we get two
9249 copies in the archive, each of which can then be extracted
9250 independently of the other:
9254 $ tar -c -vv -f ../archive.tar --hard-dereference .
9255 drwxr-xr-x gray/staff 0 2007-10-30 15:13 ./
9256 -rw-r--r-- gray/staff 4 2007-10-30 15:11 ./jeden
9257 -rw-r--r-- gray/staff 4 2007-10-30 15:11 ./one
9262 @subsection Old V7 Archives
9263 @cindex Format, old style
9264 @cindex Old style format
9265 @cindex Old style archives
9266 @cindex v7 archive format
9268 Certain old versions of @command{tar} cannot handle additional
9269 information recorded by newer @command{tar} programs. To create an
9270 archive in V7 format (not ANSI), which can be read by these old
9271 versions, specify the @option{--format=v7} option in
9272 conjunction with the @option{--create} (@option{-c}) (@command{tar} also
9273 accepts @option{--portability} or @option{--old-archive} for this
9274 option). When you specify it,
9275 @command{tar} leaves out information about directories, pipes, fifos,
9276 contiguous files, and device files, and specifies file ownership by
9277 group and user IDs instead of group and user names.
9279 When updating an archive, do not use @option{--format=v7}
9280 unless the archive was created using this option.
9282 In most cases, a @emph{new} format archive can be read by an @emph{old}
9283 @command{tar} program without serious trouble, so this option should
9284 seldom be needed. On the other hand, most modern @command{tar}s are
9285 able to read old format archives, so it might be safer for you to
9286 always use @option{--format=v7} for your distributions. Notice,
9287 however, that @samp{ustar} format is a better alternative, as it is
9288 free from many of @samp{v7}'s drawbacks.
9291 @subsection Ustar Archive Format
9293 @cindex ustar archive format
9294 Archive format defined by @acronym{POSIX}.1-1988 specification is called
9295 @code{ustar}. Although it is more flexible than the V7 format, it
9296 still has many restrictions (@xref{Formats,ustar}, for the detailed
9297 description of @code{ustar} format). Along with V7 format,
9298 @code{ustar} format is a good choice for archives intended to be read
9299 with other implementations of @command{tar}.
9301 To create archive in @code{ustar} format, use @option{--format=ustar}
9302 option in conjunction with the @option{--create} (@option{-c}).
9305 @subsection @acronym{GNU} and old @GNUTAR{} format
9307 @cindex GNU archive format
9308 @cindex Old GNU archive format
9309 @GNUTAR{} was based on an early draft of the
9310 @acronym{POSIX} 1003.1 @code{ustar} standard. @acronym{GNU} extensions to
9311 @command{tar}, such as the support for file names longer than 100
9312 characters, use portions of the @command{tar} header record which were
9313 specified in that @acronym{POSIX} draft as unused. Subsequent changes in
9314 @acronym{POSIX} have allocated the same parts of the header record for
9315 other purposes. As a result, @GNUTAR{} format is
9316 incompatible with the current @acronym{POSIX} specification, and with
9317 @command{tar} programs that follow it.
9319 In the majority of cases, @command{tar} will be configured to create
9320 this format by default. This will change in future releases, since
9321 we plan to make @samp{POSIX} format the default.
9323 To force creation a @GNUTAR{} archive, use option
9324 @option{--format=gnu}.
9327 @subsection @GNUTAR{} and @acronym{POSIX} @command{tar}
9329 @cindex POSIX archive format
9330 @cindex PAX archive format
9331 Starting from version 1.14 @GNUTAR{} features full support for
9332 @acronym{POSIX.1-2001} archives.
9334 A @acronym{POSIX} conformant archive will be created if @command{tar}
9335 was given @option{--format=posix} (@option{--format=pax}) option. No
9336 special option is required to read and extract from a @acronym{POSIX}
9340 * PAX keywords:: Controlling Extended Header Keywords.
9344 @subsubsection Controlling Extended Header Keywords
9348 @item --pax-option=@var{keyword-list}
9349 Handle keywords in @acronym{PAX} extended headers. This option is
9350 equivalent to @option{-o} option of the @command{pax} utility.
9353 @var{Keyword-list} is a comma-separated
9354 list of keyword options, each keyword option taking one of
9355 the following forms:
9358 @item delete=@var{pattern}
9359 When used with one of archive-creation commands,
9360 this option instructs @command{tar} to omit from extended header records
9361 that it produces any keywords matching the string @var{pattern}.
9363 When used in extract or list mode, this option instructs tar
9364 to ignore any keywords matching the given @var{pattern} in the extended
9365 header records. In both cases, matching is performed using the pattern
9366 matching notation described in @acronym{POSIX 1003.2}, 3.13
9367 (@pxref{wildcards}). For example:
9370 --pax-option delete=security.*
9373 would suppress security-related information.
9375 @item exthdr.name=@var{string}
9377 This keyword allows user control over the name that is written into the
9378 ustar header blocks for the extended headers. The name is obtained
9379 from @var{string} after making the following substitutions:
9381 @multitable @columnfractions .25 .55
9382 @headitem Meta-character @tab Replaced By
9383 @item %d @tab The directory name of the file, equivalent to the
9384 result of the @command{dirname} utility on the translated file name.
9385 @item %f @tab The name of the file with the directory information
9386 stripped, equivalent to the result of the @command{basename} utility
9387 on the translated file name.
9388 @item %p @tab The process @acronym{ID} of the @command{tar} process.
9389 @item %% @tab A @samp{%} character.
9392 Any other @samp{%} characters in @var{string} produce undefined
9395 If no option @samp{exthdr.name=string} is specified, @command{tar}
9396 will use the following default value:
9402 @item globexthdr.name=@var{string}
9403 This keyword allows user control over the name that is written into
9404 the ustar header blocks for global extended header records. The name
9405 is obtained from the contents of @var{string}, after making
9406 the following substitutions:
9408 @multitable @columnfractions .25 .55
9409 @headitem Meta-character @tab Replaced By
9410 @item %n @tab An integer that represents the
9411 sequence number of the global extended header record in the archive,
9413 @item %p @tab The process @acronym{ID} of the @command{tar} process.
9414 @item %% @tab A @samp{%} character.
9417 Any other @samp{%} characters in @var{string} produce undefined results.
9419 If no option @samp{globexthdr.name=string} is specified, @command{tar}
9420 will use the following default value:
9423 $TMPDIR/GlobalHead.%p.%n
9427 where @samp{$TMPDIR} represents the value of the @var{TMPDIR}
9428 environment variable. If @var{TMPDIR} is not set, @command{tar}
9431 @item @var{keyword}=@var{value}
9432 When used with one of archive-creation commands, these keyword/value pairs
9433 will be included at the beginning of the archive in a global extended
9434 header record. When used with one of archive-reading commands,
9435 @command{tar} will behave as if it has encountered these keyword/value
9436 pairs at the beginning of the archive in a global extended header
9439 @item @var{keyword}:=@var{value}
9440 When used with one of archive-creation commands, these keyword/value pairs
9441 will be included as records at the beginning of an extended header for
9442 each file. This is effectively equivalent to @var{keyword}=@var{value}
9443 form except that it creates no global extended header records.
9445 When used with one of archive-reading commands, @command{tar} will
9446 behave as if these keyword/value pairs were included as records at the
9447 end of each extended header; thus, they will override any global or
9448 file-specific extended header record keywords of the same names.
9449 For example, in the command:
9452 tar --format=posix --create \
9453 --file archive --pax-option gname:=user .
9456 the group name will be forced to a new value for all files
9457 stored in the archive.
9461 @subsection Checksumming Problems
9463 SunOS and HP-UX @command{tar} fail to accept archives created using
9464 @GNUTAR{} and containing non-@acronym{ASCII} file names, that
9465 is, file names having characters with the eight bit set, because they
9466 use signed checksums, while @GNUTAR{} uses unsigned
9467 checksums while creating archives, as per @acronym{POSIX} standards. On
9468 reading, @GNUTAR{} computes both checksums and
9469 accepts any. It is somewhat worrying that a lot of people may go
9470 around doing backup of their files using faulty (or at least
9471 non-standard) software, not learning about it until it's time to
9472 restore their missing files with an incompatible file extractor, or
9475 @GNUTAR{} compute checksums both ways, and accept
9476 any on read, so @acronym{GNU} tar can read Sun tapes even with their
9477 wrong checksums. @GNUTAR{} produces the standard
9478 checksum, however, raising incompatibilities with Sun. That is to
9479 say, @GNUTAR{} has not been modified to
9480 @emph{produce} incorrect archives to be read by buggy @command{tar}'s.
9481 I've been told that more recent Sun @command{tar} now read standard
9482 archives, so maybe Sun did a similar patch, after all?
9484 The story seems to be that when Sun first imported @command{tar}
9485 sources on their system, they recompiled it without realizing that
9486 the checksums were computed differently, because of a change in
9487 the default signing of @code{char}'s in their compiler. So they
9488 started computing checksums wrongly. When they later realized their
9489 mistake, they merely decided to stay compatible with it, and with
9490 themselves afterwards. Presumably, but I do not really know, HP-UX
9491 has chosen that their @command{tar} archives to be compatible with Sun's.
9492 The current standards do not favor Sun @command{tar} format. In any
9493 case, it now falls on the shoulders of SunOS and HP-UX users to get
9494 a @command{tar} able to read the good archives they receive.
9496 @node Large or Negative Values
9497 @subsection Large or Negative Values
9498 @cindex large values
9499 @cindex future time stamps
9500 @cindex negative time stamps
9503 The above sections suggest to use @samp{oldest possible} archive
9504 format if in doubt. However, sometimes it is not possible. If you
9505 attempt to archive a file whose metadata cannot be represented using
9506 required format, @GNUTAR{} will print error message and ignore such a
9507 file. You will than have to switch to a format that is able to
9508 handle such values. The format summary table (@pxref{Formats}) will
9511 In particular, when trying to archive files larger than 8GB or with
9512 timestamps not in the range 1970-01-01 00:00:00 through 2242-03-16
9513 12:56:31 @sc{utc}, you will have to chose between @acronym{GNU} and
9514 @acronym{POSIX} archive formats. When considering which format to
9515 choose, bear in mind that the @acronym{GNU} format uses
9516 two's-complement base-256 notation to store values that do not fit
9517 into standard @acronym{ustar} range. Such archives can generally be
9518 read only by a @GNUTAR{} implementation. Moreover, they sometimes
9519 cannot be correctly restored on another hosts even by @GNUTAR{}. For
9520 example, using two's complement representation for negative time
9521 stamps that assumes a signed 32-bit @code{time_t} generates archives
9522 that are not portable to hosts with differing @code{time_t}
9525 On the other hand, @acronym{POSIX} archives, generally speaking, can
9526 be extracted by any tar implementation that understands older
9527 @acronym{ustar} format. The only exception are files larger than 8GB.
9529 @FIXME{Describe how @acronym{POSIX} archives are extracted by non
9533 @subsection How to Extract GNU-Specific Data Using Other @command{tar} Implementations
9535 In previous sections you became acquainted with various quirks
9536 necessary to make your archives portable. Sometimes you may need to
9537 extract archives containing GNU-specific members using some
9538 third-party @command{tar} implementation or an older version of
9539 @GNUTAR{}. Of course your best bet is to have @GNUTAR{} installed,
9540 but if it is for some reason impossible, this section will explain
9541 how to cope without it.
9543 When we speak about @dfn{GNU-specific} members we mean two classes of
9544 them: members split between the volumes of a multi-volume archive and
9545 sparse members. You will be able to always recover such members if
9546 the archive is in PAX format. In addition split members can be
9547 recovered from archives in old GNU format. The following subsections
9548 describe the required procedures in detail.
9551 * Split Recovery:: Members Split Between Volumes
9552 * Sparse Recovery:: Sparse Members
9555 @node Split Recovery
9556 @subsubsection Extracting Members Split Between Volumes
9558 @cindex Mutli-volume archives, extracting using non-GNU tars
9559 If a member is split between several volumes of an old GNU format archive
9560 most third party @command{tar} implementation will fail to extract
9561 it. To extract it, use @command{tarcat} program (@pxref{Tarcat}).
9562 This program is available from
9563 @uref{http://www.gnu.org/@/software/@/tar/@/utils/@/tarcat.html, @GNUTAR{}
9564 home page}. It concatenates several archive volumes into a single
9565 valid archive. For example, if you have three volumes named from
9566 @file{vol-1.tar} to @file{vol-3.tar}, you can do the following to
9567 extract them using a third-party @command{tar}:
9570 $ @kbd{tarcat vol-1.tar vol-2.tar vol-3.tar | tar xf -}
9573 @cindex Mutli-volume archives in PAX format, extracting using non-GNU tars
9574 You could use this approach for most (although not all) PAX
9575 format archives as well. However, extracting split members from a PAX
9576 archive is a much easier task, because PAX volumes are constructed in
9577 such a way that each part of a split member is extracted to a
9578 different file by @command{tar} implementations that are not aware of
9579 GNU extensions. More specifically, the very first part retains its
9580 original name, and all subsequent parts are named using the pattern:
9583 %d/GNUFileParts.%p/%f.%n
9587 where symbols preceeded by @samp{%} are @dfn{macro characters} that
9588 have the following meaning:
9590 @multitable @columnfractions .25 .55
9591 @headitem Meta-character @tab Replaced By
9592 @item %d @tab The directory name of the file, equivalent to the
9593 result of the @command{dirname} utility on its full name.
9594 @item %f @tab The file name of the file, equivalent to the result
9595 of the @command{basename} utility on its full name.
9596 @item %p @tab The process @acronym{ID} of the @command{tar} process that
9597 created the archive.
9598 @item %n @tab Ordinal number of this particular part.
9601 For example, if the file @file{var/longfile} was split during archive
9602 creation between three volumes, and the creator @command{tar} process
9603 had process @acronym{ID} @samp{27962}, then the member names will be:
9607 var/GNUFileParts.27962/longfile.1
9608 var/GNUFileParts.27962/longfile.2
9611 When you extract your archive using a third-party @command{tar}, these
9612 files will be created on your disk, and the only thing you will need
9613 to do to restore your file in its original form is concatenate them in
9614 the proper order, for example:
9619 $ @kbd{cat GNUFileParts.27962/longfile.1 \
9620 GNUFileParts.27962/longfile.2 >> longfile}
9621 $ rm -f GNUFileParts.27962
9625 Notice, that if the @command{tar} implementation you use supports PAX
9626 format archives, it will probably emit warnings about unknown keywords
9627 during extraction. They will look like this:
9632 Unknown extended header keyword 'GNU.volume.filename' ignored.
9633 Unknown extended header keyword 'GNU.volume.size' ignored.
9634 Unknown extended header keyword 'GNU.volume.offset' ignored.
9639 You can safely ignore these warnings.
9641 If your @command{tar} implementation is not PAX-aware, you will get
9642 more warnings and more files generated on your disk, e.g.:
9646 $ @kbd{tar xf vol-1.tar}
9647 var/PaxHeaders.27962/longfile: Unknown file type 'x', extracted as
9649 Unexpected EOF in archive
9650 $ @kbd{tar xf vol-2.tar}
9651 tmp/GlobalHead.27962.1: Unknown file type 'g', extracted as normal file
9652 GNUFileParts.27962/PaxHeaders.27962/sparsefile.1: Unknown file type
9653 'x', extracted as normal file
9657 Ignore these warnings. The @file{PaxHeaders.*} directories created
9658 will contain files with @dfn{extended header keywords} describing the
9659 extracted files. You can delete them, unless they describe sparse
9660 members. Read further to learn more about them.
9662 @node Sparse Recovery
9663 @subsubsection Extracting Sparse Members
9665 @cindex sparse files, extracting with non-GNU tars
9666 Any @command{tar} implementation will be able to extract sparse members from a
9667 PAX archive. However, the extracted files will be @dfn{condensed},
9668 i.e., any zero blocks will be removed from them. When we restore such
9669 a condensed file to its original form, by adding zero blocks (or
9670 @dfn{holes}) back to their original locations, we call this process
9671 @dfn{expanding} a compressed sparse file.
9674 To expand a file, you will need a simple auxiliary program called
9675 @command{xsparse}. It is available in source form from
9676 @uref{http://www.gnu.org/@/software/@/tar/@/utils/@/xsparse.html, @GNUTAR{}
9679 @cindex sparse files v.1.0, extracting with non-GNU tars
9680 Let's begin with archive members in @dfn{sparse format
9681 version 1.0}@footnote{@xref{PAX 1}.}, which are the easiest to expand.
9682 The condensed file will contain both file map and file data, so no
9683 additional data will be needed to restore it. If the original file
9684 name was @file{@var{dir}/@var{name}}, then the condensed file will be
9685 named @file{@var{dir}/@/GNUSparseFile.@var{n}/@/@var{name}}, where
9686 @var{n} is a decimal number@footnote{technically speaking, @var{n} is a
9687 @dfn{process @acronym{ID}} of the @command{tar} process which created the
9688 archive (@pxref{PAX keywords}).}.
9690 To expand a version 1.0 file, run @command{xsparse} as follows:
9693 $ @kbd{xsparse @file{cond-file}}
9697 where @file{cond-file} is the name of the condensed file. The utility
9698 will deduce the name for the resulting expanded file using the
9699 following algorithm:
9702 @item If @file{cond-file} does not contain any directories,
9703 @file{../cond-file} will be used;
9705 @item If @file{cond-file} has the form
9706 @file{@var{dir}/@var{t}/@var{name}}, where both @var{t} and @var{name}
9707 are simple names, with no @samp{/} characters in them, the output file
9708 name will be @file{@var{dir}/@var{name}}.
9710 @item Otherwise, if @file{cond-file} has the form
9711 @file{@var{dir}/@var{name}}, the output file name will be
9715 In the unlikely case when this algorithm does not suit your needs,
9716 you can explicitly specify output file name as a second argument to
9720 $ @kbd{xsparse @file{cond-file} @file{out-file}}
9723 It is often a good idea to run @command{xsparse} in @dfn{dry run} mode
9724 first. In this mode, the command does not actually expand the file,
9725 but verbosely lists all actions it would be taking to do so. The dry
9726 run mode is enabled by @option{-n} command line argument:
9730 $ @kbd{xsparse -n /home/gray/GNUSparseFile.6058/sparsefile}
9731 Reading v.1.0 sparse map
9732 Expanding file `/home/gray/GNUSparseFile.6058/sparsefile' to
9733 `/home/gray/sparsefile'
9738 To actually expand the file, you would run:
9741 $ @kbd{xsparse /home/gray/GNUSparseFile.6058/sparsefile}
9745 The program behaves the same way all UNIX utilities do: it will keep
9746 quiet unless it has simething important to tell you (e.g. an error
9747 condition or something). If you wish it to produce verbose output,
9748 similar to that from the dry run mode, use @option{-v} option:
9752 $ @kbd{xsparse -v /home/gray/GNUSparseFile.6058/sparsefile}
9753 Reading v.1.0 sparse map
9754 Expanding file `/home/gray/GNUSparseFile.6058/sparsefile' to
9755 `/home/gray/sparsefile'
9760 Additionally, if your @command{tar} implementation has extracted the
9761 @dfn{extended headers} for this file, you can instruct @command{xstar}
9762 to use them in order to verify the integrity of the expanded file.
9763 The option @option{-x} sets the name of the extended header file to
9764 use. Continuing our example:
9768 $ @kbd{xsparse -v -x /home/gray/PaxHeaders.6058/sparsefile \
9769 /home/gray/GNUSparseFile.6058/sparsefile}
9770 Reading extended header file
9771 Found variable GNU.sparse.major = 1
9772 Found variable GNU.sparse.minor = 0
9773 Found variable GNU.sparse.name = sparsefile
9774 Found variable GNU.sparse.realsize = 217481216
9775 Reading v.1.0 sparse map
9776 Expanding file `/home/gray/GNUSparseFile.6058/sparsefile' to
9777 `/home/gray/sparsefile'
9782 @anchor{extracting sparse v.0.x}
9783 @cindex sparse files v.0.1, extracting with non-GNU tars
9784 @cindex sparse files v.0.0, extracting with non-GNU tars
9785 An @dfn{extended header} is a special @command{tar} archive header
9786 that precedes an archive member and contains a set of
9787 @dfn{variables}, describing the member properties that cannot be
9788 stored in the standard @code{ustar} header. While optional for
9789 expanding sparse version 1.0 members, the use of extended headers is
9790 mandatory when expanding sparse members in older sparse formats: v.0.0
9791 and v.0.1 (The sparse formats are described in detail in @ref{Sparse
9792 Formats}.) So, for these formats, the question is: how to obtain
9793 extended headers from the archive?
9795 If you use a @command{tar} implementation that does not support PAX
9796 format, extended headers for each member will be extracted as a
9797 separate file. If we represent the member name as
9798 @file{@var{dir}/@var{name}}, then the extended header file will be
9799 named @file{@var{dir}/@/PaxHeaders.@var{n}/@/@var{name}}, where
9800 @var{n} is an integer number.
9802 Things become more difficult if your @command{tar} implementation
9803 does support PAX headers, because in this case you will have to
9804 manually extract the headers. We recommend the following algorithm:
9808 Consult the documentation of your @command{tar} implementation for an
9809 option that prints @dfn{block numbers} along with the archive
9810 listing (analogous to @GNUTAR{}'s @option{-R} option). For example,
9811 @command{star} has @option{-block-number}.
9814 Obtain verbose listing using the @samp{block number} option, and
9815 find block numbers of the sparse member in question and the member
9816 immediately following it. For example, running @command{star} on our
9821 $ @kbd{star -t -v -block-number -f arc.tar}
9823 star: Unknown extended header keyword 'GNU.sparse.size' ignored.
9824 star: Unknown extended header keyword 'GNU.sparse.numblocks' ignored.
9825 star: Unknown extended header keyword 'GNU.sparse.name' ignored.
9826 star: Unknown extended header keyword 'GNU.sparse.map' ignored.
9827 block 56: 425984 -rw-r--r-- gray/users Jun 25 14:46 2006 GNUSparseFile.28124/sparsefile
9828 block 897: 65391 -rw-r--r-- gray/users Jun 24 20:06 2006 README
9834 (as usual, ignore the warnings about unknown keywords.)
9837 Let @var{size} be the size of the sparse member, @var{Bs} be its block number
9838 and @var{Bn} be the block number of the next member.
9842 @var{N} = @var{Bs} - @var{Bn} - @var{size}/512 - 2
9846 This number gives the size of the extended header part in tar @dfn{blocks}.
9847 In our example, this formula gives: @code{897 - 56 - 425984 / 512 - 2
9851 Use @command{dd} to extract the headers:
9854 @kbd{dd if=@var{archive} of=@var{hname} bs=512 skip=@var{Bs} count=@var{N}}
9858 where @var{archive} is the archive name, @var{hname} is a name of the
9859 file to store the extended header in, @var{Bs} and @var{N} are
9860 computed in previous steps.
9862 In our example, this command will be
9865 $ @kbd{dd if=arc.tar of=xhdr bs=512 skip=56 count=7}
9869 Finally, you can expand the condensed file, using the obtained header:
9873 $ @kbd{xsparse -v -x xhdr GNUSparseFile.6058/sparsefile}
9874 Reading extended header file
9875 Found variable GNU.sparse.size = 217481216
9876 Found variable GNU.sparse.numblocks = 208
9877 Found variable GNU.sparse.name = sparsefile
9878 Found variable GNU.sparse.map = 0,2048,1050624,2048,@dots{}
9879 Expanding file `GNUSparseFile.28124/sparsefile' to `sparsefile'
9885 @section Comparison of @command{tar} and @command{cpio}
9888 @FIXME{Reorganize the following material}
9890 The @command{cpio} archive formats, like @command{tar}, do have maximum
9891 file name lengths. The binary and old @acronym{ASCII} formats have a maximum file
9892 length of 256, and the new @acronym{ASCII} and @acronym{CRC ASCII} formats have a max
9893 file length of 1024. @acronym{GNU} @command{cpio} can read and write archives
9894 with arbitrary file name lengths, but other @command{cpio} implementations
9895 may crash unexplainedly trying to read them.
9897 @command{tar} handles symbolic links in the form in which it comes in @acronym{BSD};
9898 @command{cpio} doesn't handle symbolic links in the form in which it comes
9899 in System V prior to SVR4, and some vendors may have added symlinks
9900 to their system without enhancing @command{cpio} to know about them.
9901 Others may have enhanced it in a way other than the way I did it
9902 at Sun, and which was adopted by AT&T (and which is, I think, also
9903 present in the @command{cpio} that Berkeley picked up from AT&T and put
9904 into a later @acronym{BSD} release---I think I gave them my changes).
9906 (SVR4 does some funny stuff with @command{tar}; basically, its @command{cpio}
9907 can handle @command{tar} format input, and write it on output, and it
9908 probably handles symbolic links. They may not have bothered doing
9909 anything to enhance @command{tar} as a result.)
9911 @command{cpio} handles special files; traditional @command{tar} doesn't.
9913 @command{tar} comes with V7, System III, System V, and @acronym{BSD} source;
9914 @command{cpio} comes only with System III, System V, and later @acronym{BSD}
9915 (4.3-tahoe and later).
9917 @command{tar}'s way of handling multiple hard links to a file can handle
9918 file systems that support 32-bit inumbers (e.g., the @acronym{BSD} file system);
9919 @command{cpio}s way requires you to play some games (in its ``binary''
9920 format, i-numbers are only 16 bits, and in its ``portable @acronym{ASCII}'' format,
9921 they're 18 bits---it would have to play games with the "file system @acronym{ID}"
9922 field of the header to make sure that the file system @acronym{ID}/i-number pairs
9923 of different files were always different), and I don't know which
9924 @command{cpio}s, if any, play those games. Those that don't might get
9925 confused and think two files are the same file when they're not, and
9926 make hard links between them.
9928 @command{tar}s way of handling multiple hard links to a file places only
9929 one copy of the link on the tape, but the name attached to that copy
9930 is the @emph{only} one you can use to retrieve the file; @command{cpio}s
9931 way puts one copy for every link, but you can retrieve it using any
9935 What type of check sum (if any) is used, and how is this calculated.
9938 See the attached manual pages for @command{tar} and @command{cpio} format.
9939 @command{tar} uses a checksum which is the sum of all the bytes in the
9940 @command{tar} header for a file; @command{cpio} uses no checksum.
9943 If anyone knows why @command{cpio} was made when @command{tar} was present
9947 It wasn't. @command{cpio} first showed up in PWB/UNIX 1.0; no
9948 generally-available version of UNIX had @command{tar} at the time. I don't
9949 know whether any version that was generally available @emph{within AT&T}
9950 had @command{tar}, or, if so, whether the people within AT&T who did
9951 @command{cpio} knew about it.
9953 On restore, if there is a corruption on a tape @command{tar} will stop at
9954 that point, while @command{cpio} will skip over it and try to restore the
9957 The main difference is just in the command syntax and header format.
9959 @command{tar} is a little more tape-oriented in that everything is blocked
9960 to start on a record boundary.
9963 Is there any differences between the ability to recover crashed
9964 archives between the two of them. (Is there any chance of recovering
9965 crashed archives at all.)
9968 Theoretically it should be easier under @command{tar} since the blocking
9969 lets you find a header with some variation of @samp{dd skip=@var{nn}}.
9970 However, modern @command{cpio}'s and variations have an option to just
9971 search for the next file header after an error with a reasonable chance
9972 of resyncing. However, lots of tape driver software won't allow you to
9973 continue past a media error which should be the only reason for getting
9974 out of sync unless a file changed sizes while you were writing the
9978 If anyone knows why @command{cpio} was made when @command{tar} was present
9979 at the unix scene, please tell me about this too.
9982 Probably because it is more media efficient (by not blocking everything
9983 and using only the space needed for the headers where @command{tar}
9984 always uses 512 bytes per file header) and it knows how to archive
9987 You might want to look at the freely available alternatives. The
9988 major ones are @command{afio}, @GNUTAR{}, and
9989 @command{pax}, each of which have their own extensions with some
9990 backwards compatibility.
9992 Sparse files were @command{tar}red as sparse files (which you can
9993 easily test, because the resulting archive gets smaller, and
9994 @acronym{GNU} @command{cpio} can no longer read it).
9997 @chapter Tapes and Other Archive Media
10000 A few special cases about tape handling warrant more detailed
10001 description. These special cases are discussed below.
10003 Many complexities surround the use of @command{tar} on tape drives. Since
10004 the creation and manipulation of archives located on magnetic tape was
10005 the original purpose of @command{tar}, it contains many features making
10006 such manipulation easier.
10008 Archives are usually written on dismountable media---tape cartridges,
10009 mag tapes, or floppy disks.
10011 The amount of data a tape or disk holds depends not only on its size,
10012 but also on how it is formatted. A 2400 foot long reel of mag tape
10013 holds 40 megabytes of data when formatted at 1600 bits per inch. The
10014 physically smaller EXABYTE tape cartridge holds 2.3 gigabytes.
10016 Magnetic media are re-usable---once the archive on a tape is no longer
10017 needed, the archive can be erased and the tape or disk used over.
10018 Media quality does deteriorate with use, however. Most tapes or disks
10019 should be discarded when they begin to produce data errors. EXABYTE
10020 tape cartridges should be discarded when they generate an @dfn{error
10021 count} (number of non-usable bits) of more than 10k.
10023 Magnetic media are written and erased using magnetic fields, and
10024 should be protected from such fields to avoid damage to stored data.
10025 Sticking a floppy disk to a filing cabinet using a magnet is probably
10029 * Device:: Device selection and switching
10030 * Remote Tape Server::
10031 * Common Problems and Solutions::
10032 * Blocking:: Blocking
10033 * Many:: Many archives on one tape
10034 * Using Multiple Tapes:: Using Multiple Tapes
10035 * label:: Including a Label in the Archive
10037 * Write Protection::
10041 @section Device Selection and Switching
10045 @item -f [@var{hostname}:]@var{file}
10046 @itemx --file=[@var{hostname}:]@var{file}
10047 Use archive file or device @var{file} on @var{hostname}.
10050 This option is used to specify the file name of the archive @command{tar}
10053 If the file name is @samp{-}, @command{tar} reads the archive from standard
10054 input (when listing or extracting), or writes it to standard output
10055 (when creating). If the @samp{-} file name is given when updating an
10056 archive, @command{tar} will read the original archive from its standard
10057 input, and will write the entire new archive to its standard output.
10059 If the file name contains a @samp{:}, it is interpreted as
10060 @samp{hostname:file name}. If the @var{hostname} contains an @dfn{at}
10061 sign (@samp{@@}), it is treated as @samp{user@@hostname:file name}. In
10062 either case, @command{tar} will invoke the command @command{rsh} (or
10063 @command{remsh}) to start up an @command{/usr/libexec/rmt} on the remote
10064 machine. If you give an alternate login name, it will be given to the
10066 Naturally, the remote machine must have an executable
10067 @command{/usr/libexec/rmt}. This program is free software from the
10068 University of California, and a copy of the source code can be found
10069 with the sources for @command{tar}; it's compiled and installed by default.
10070 The exact path to this utility is determined when configuring the package.
10071 It is @file{@var{prefix}/libexec/rmt}, where @var{prefix} stands for
10072 your installation prefix. This location may also be overridden at
10073 runtime by using @option{rmt-command=@var{command}} option (@xref{Option Summary,
10074 ---rmt-command}, for detailed description of this option. @xref{Remote
10075 Tape Server}, for the description of @command{rmt} command).
10077 If this option is not given, but the environment variable @env{TAPE}
10078 is set, its value is used; otherwise, old versions of @command{tar}
10079 used a default archive name (which was picked when @command{tar} was
10080 compiled). The default is normally set up to be the @dfn{first} tape
10081 drive or other transportable I/O medium on the system.
10083 Starting with version 1.11.5, @GNUTAR{} uses
10084 standard input and standard output as the default device, and I will
10085 not try anymore supporting automatic device detection at installation
10086 time. This was failing really in too many cases, it was hopeless.
10087 This is now completely left to the installer to override standard
10088 input and standard output for default device, if this seems
10089 preferable. Further, I think @emph{most} actual usages of
10090 @command{tar} are done with pipes or disks, not really tapes,
10091 cartridges or diskettes.
10093 Some users think that using standard input and output is running
10094 after trouble. This could lead to a nasty surprise on your screen if
10095 you forget to specify an output file name---especially if you are going
10096 through a network or terminal server capable of buffering large amounts
10097 of output. We had so many bug reports in that area of configuring
10098 default tapes automatically, and so many contradicting requests, that
10099 we finally consider the problem to be portably intractable. We could
10100 of course use something like @samp{/dev/tape} as a default, but this
10101 is @emph{also} running after various kind of trouble, going from hung
10102 processes to accidental destruction of real tapes. After having seen
10103 all this mess, using standard input and output as a default really
10104 sounds like the only clean choice left, and a very useful one too.
10106 @GNUTAR{} reads and writes archive in records, I
10107 suspect this is the main reason why block devices are preferred over
10108 character devices. Most probably, block devices are more efficient
10109 too. The installer could also check for @samp{DEFTAPE} in
10110 @file{<sys/mtio.h>}.
10113 @xopindex{force-local, short description}
10114 @item --force-local
10115 Archive file is local even if it contains a colon.
10117 @opindex rsh-command
10118 @item --rsh-command=@var{command}
10119 Use remote @var{command} instead of @command{rsh}. This option exists
10120 so that people who use something other than the standard @command{rsh}
10121 (e.g., a Kerberized @command{rsh}) can access a remote device.
10123 When this command is not used, the shell command found when
10124 the @command{tar} program was installed is used instead. This is
10125 the first found of @file{/usr/ucb/rsh}, @file{/usr/bin/remsh},
10126 @file{/usr/bin/rsh}, @file{/usr/bsd/rsh} or @file{/usr/bin/nsh}.
10127 The installer may have overridden this by defining the environment
10128 variable @env{RSH} @emph{at installation time}.
10131 Specify drive and density.
10133 @xopindex{multi-volume, short description}
10135 @itemx --multi-volume
10136 Create/list/extract multi-volume archive.
10138 This option causes @command{tar} to write a @dfn{multi-volume} archive---one
10139 that may be larger than will fit on the medium used to hold it.
10140 @xref{Multi-Volume Archives}.
10142 @xopindex{tape-length, short description}
10144 @itemx --tape-length=@var{num}
10145 Change tape after writing @var{num} x 1024 bytes.
10147 This option might be useful when your tape drivers do not properly
10148 detect end of physical tapes. By being slightly conservative on the
10149 maximum tape length, you might avoid the problem entirely.
10151 @xopindex{info-script, short description}
10152 @xopindex{new-volume-script, short description}
10153 @item -F @var{file}
10154 @itemx --info-script=@var{file}
10155 @itemx --new-volume-script=@var{file}
10156 Execute @file{file} at end of each tape. This implies
10157 @option{--multi-volume} (@option{-M}). @xref{info-script}, for a detailed
10158 description of this option.
10161 @node Remote Tape Server
10162 @section The Remote Tape Server
10164 @cindex remote tape drive
10166 In order to access the tape drive on a remote machine, @command{tar}
10167 uses the remote tape server written at the University of California at
10168 Berkeley. The remote tape server must be installed as
10169 @file{@var{prefix}/libexec/rmt} on any machine whose tape drive you
10170 want to use. @command{tar} calls @command{rmt} by running an
10171 @command{rsh} or @command{remsh} to the remote machine, optionally
10172 using a different login name if one is supplied.
10174 A copy of the source for the remote tape server is provided. It is
10175 Copyright @copyright{} 1983 by the Regents of the University of
10176 California, but can be freely distributed. It is compiled and
10177 installed by default.
10179 @cindex absolute file names
10180 Unless you use the @option{--absolute-names} (@option{-P}) option,
10181 @GNUTAR{} will not allow you to create an archive that contains
10182 absolute file names (a file name beginning with @samp{/}.) If you try,
10183 @command{tar} will automatically remove the leading @samp{/} from the
10184 file names it stores in the archive. It will also type a warning
10185 message telling you what it is doing.
10187 When reading an archive that was created with a different
10188 @command{tar} program, @GNUTAR{} automatically
10189 extracts entries in the archive which have absolute file names as if
10190 the file names were not absolute. This is an important feature. A
10191 visitor here once gave a @command{tar} tape to an operator to restore;
10192 the operator used Sun @command{tar} instead of @GNUTAR{},
10193 and the result was that it replaced large portions of
10194 our @file{/bin} and friends with versions from the tape; needless to
10195 say, we were unhappy about having to recover the file system from
10198 For example, if the archive contained a file @file{/usr/bin/computoy},
10199 @GNUTAR{} would extract the file to @file{usr/bin/computoy},
10200 relative to the current directory. If you want to extract the files in
10201 an archive to the same absolute names that they had when the archive
10202 was created, you should do a @samp{cd /} before extracting the files
10203 from the archive, or you should either use the @option{--absolute-names}
10204 option, or use the command @samp{tar -C / @dots{}}.
10206 @cindex Ultrix 3.1 and write failure
10207 Some versions of Unix (Ultrix 3.1 is known to have this problem),
10208 can claim that a short write near the end of a tape succeeded,
10209 when it actually failed. This will result in the -M option not
10210 working correctly. The best workaround at the moment is to use a
10211 significantly larger blocking factor than the default 20.
10213 In order to update an archive, @command{tar} must be able to backspace the
10214 archive in order to reread or rewrite a record that was just read (or
10215 written). This is currently possible only on two kinds of files: normal
10216 disk files (or any other file that can be backspaced with @samp{lseek}),
10217 and industry-standard 9-track magnetic tape (or any other kind of tape
10218 that can be backspaced with the @code{MTIOCTOP} @code{ioctl}.
10220 This means that the @option{--append}, @option{--concatenate}, and
10221 @option{--delete} commands will not work on any other kind of file.
10222 Some media simply cannot be backspaced, which means these commands and
10223 options will never be able to work on them. These non-backspacing
10224 media include pipes and cartridge tape drives.
10226 Some other media can be backspaced, and @command{tar} will work on them
10227 once @command{tar} is modified to do so.
10229 Archives created with the @option{--multi-volume}, @option{--label}, and
10230 @option{--incremental} (@option{-G}) options may not be readable by other version
10231 of @command{tar}. In particular, restoring a file that was split over
10232 a volume boundary will require some careful work with @command{dd}, if
10233 it can be done at all. Other versions of @command{tar} may also create
10234 an empty file whose name is that of the volume header. Some versions
10235 of @command{tar} may create normal files instead of directories archived
10236 with the @option{--incremental} (@option{-G}) option.
10238 @node Common Problems and Solutions
10239 @section Some Common Problems and their Solutions
10244 errors from system:
10246 no such file or directory
10249 errors from @command{tar}:
10250 directory checksum error
10251 header format error
10253 errors from media/system:
10265 @dfn{Block} and @dfn{record} terminology is rather confused, and it
10266 is also confusing to the expert reader. On the other hand, readers
10267 who are new to the field have a fresh mind, and they may safely skip
10268 the next two paragraphs, as the remainder of this manual uses those
10269 two terms in a quite consistent way.
10271 John Gilmore, the writer of the public domain @command{tar} from which
10272 @GNUTAR{} was originally derived, wrote (June 1995):
10275 The nomenclature of tape drives comes from IBM, where I believe
10276 they were invented for the IBM 650 or so. On IBM mainframes, what
10277 is recorded on tape are tape blocks. The logical organization of
10278 data is into records. There are various ways of putting records into
10279 blocks, including @code{F} (fixed sized records), @code{V} (variable
10280 sized records), @code{FB} (fixed blocked: fixed size records, @var{n}
10281 to a block), @code{VB} (variable size records, @var{n} to a block),
10282 @code{VSB} (variable spanned blocked: variable sized records that can
10283 occupy more than one block), etc. The @code{JCL} @samp{DD RECFORM=}
10284 parameter specified this to the operating system.
10286 The Unix man page on @command{tar} was totally confused about this.
10287 When I wrote @code{PD TAR}, I used the historically correct terminology
10288 (@command{tar} writes data records, which are grouped into blocks).
10289 It appears that the bogus terminology made it into @acronym{POSIX} (no surprise
10290 here), and now Fran@,{c}ois has migrated that terminology back
10291 into the source code too.
10294 The term @dfn{physical block} means the basic transfer chunk from or
10295 to a device, after which reading or writing may stop without anything
10296 being lost. In this manual, the term @dfn{block} usually refers to
10297 a disk physical block, @emph{assuming} that each disk block is 512
10298 bytes in length. It is true that some disk devices have different
10299 physical blocks, but @command{tar} ignore these differences in its own
10300 format, which is meant to be portable, so a @command{tar} block is always
10301 512 bytes in length, and @dfn{block} always mean a @command{tar} block.
10302 The term @dfn{logical block} often represents the basic chunk of
10303 allocation of many disk blocks as a single entity, which the operating
10304 system treats somewhat atomically; this concept is only barely used
10307 The term @dfn{physical record} is another way to speak of a physical
10308 block, those two terms are somewhat interchangeable. In this manual,
10309 the term @dfn{record} usually refers to a tape physical block,
10310 @emph{assuming} that the @command{tar} archive is kept on magnetic tape.
10311 It is true that archives may be put on disk or used with pipes,
10312 but nevertheless, @command{tar} tries to read and write the archive one
10313 @dfn{record} at a time, whatever the medium in use. One record is made
10314 up of an integral number of blocks, and this operation of putting many
10315 disk blocks into a single tape block is called @dfn{reblocking}, or
10316 more simply, @dfn{blocking}. The term @dfn{logical record} refers to
10317 the logical organization of many characters into something meaningful
10318 to the application. The term @dfn{unit record} describes a small set
10319 of characters which are transmitted whole to or by the application,
10320 and often refers to a line of text. Those two last terms are unrelated
10321 to what we call a @dfn{record} in @GNUTAR{}.
10323 When writing to tapes, @command{tar} writes the contents of the archive
10324 in chunks known as @dfn{records}. To change the default blocking
10325 factor, use the @option{--blocking-factor=@var{512-size}} (@option{-b
10326 @var{512-size}}) option. Each record will then be composed of
10327 @var{512-size} blocks. (Each @command{tar} block is 512 bytes.
10328 @xref{Standard}.) Each file written to the archive uses at least one
10329 full record. As a result, using a larger record size can result in
10330 more wasted space for small files. On the other hand, a larger record
10331 size can often be read and written much more efficiently.
10333 Further complicating the problem is that some tape drives ignore the
10334 blocking entirely. For these, a larger record size can still improve
10335 performance (because the software layers above the tape drive still
10336 honor the blocking), but not as dramatically as on tape drives that
10339 When reading an archive, @command{tar} can usually figure out the
10340 record size on itself. When this is the case, and a non-standard
10341 record size was used when the archive was created, @command{tar} will
10342 print a message about a non-standard blocking factor, and then operate
10343 normally. On some tape devices, however, @command{tar} cannot figure
10344 out the record size itself. On most of those, you can specify a
10345 blocking factor (with @option{--blocking-factor}) larger than the
10346 actual blocking factor, and then use the @option{--read-full-records}
10347 (@option{-B}) option. (If you specify a blocking factor with
10348 @option{--blocking-factor} and don't use the
10349 @option{--read-full-records} option, then @command{tar} will not
10350 attempt to figure out the recording size itself.) On some devices,
10351 you must always specify the record size exactly with
10352 @option{--blocking-factor} when reading, because @command{tar} cannot
10353 figure it out. In any case, use @option{--list} (@option{-t}) before
10354 doing any extractions to see whether @command{tar} is reading the archive
10357 @command{tar} blocks are all fixed size (512 bytes), and its scheme for
10358 putting them into records is to put a whole number of them (one or
10359 more) into each record. @command{tar} records are all the same size;
10360 at the end of the file there's a block containing all zeros, which
10361 is how you tell that the remainder of the last record(s) are garbage.
10363 In a standard @command{tar} file (no options), the block size is 512
10364 and the record size is 10240, for a blocking factor of 20. What the
10365 @option{--blocking-factor} option does is sets the blocking factor,
10366 changing the record size while leaving the block size at 512 bytes.
10367 20 was fine for ancient 800 or 1600 bpi reel-to-reel tape drives;
10368 most tape drives these days prefer much bigger records in order to
10369 stream and not waste tape. When writing tapes for myself, some tend
10370 to use a factor of the order of 2048, say, giving a record size of
10371 around one megabyte.
10373 If you use a blocking factor larger than 20, older @command{tar}
10374 programs might not be able to read the archive, so we recommend this
10375 as a limit to use in practice. @GNUTAR{}, however,
10376 will support arbitrarily large record sizes, limited only by the
10377 amount of virtual memory or the physical characteristics of the tape
10381 * Format Variations:: Format Variations
10382 * Blocking Factor:: The Blocking Factor of an Archive
10385 @node Format Variations
10386 @subsection Format Variations
10387 @cindex Format Parameters
10388 @cindex Format Options
10389 @cindex Options, archive format specifying
10390 @cindex Options, format specifying
10393 Format parameters specify how an archive is written on the archive
10394 media. The best choice of format parameters will vary depending on
10395 the type and number of files being archived, and on the media used to
10398 To specify format parameters when accessing or creating an archive,
10399 you can use the options described in the following sections.
10400 If you do not specify any format parameters, @command{tar} uses
10401 default parameters. You cannot modify a compressed archive.
10402 If you create an archive with the @option{--blocking-factor} option
10403 specified (@pxref{Blocking Factor}), you must specify that
10404 blocking-factor when operating on the archive. @xref{Formats}, for other
10405 examples of format parameter considerations.
10407 @node Blocking Factor
10408 @subsection The Blocking Factor of an Archive
10409 @cindex Blocking Factor
10410 @cindex Record Size
10411 @cindex Number of blocks per record
10412 @cindex Number of bytes per record
10413 @cindex Bytes per record
10414 @cindex Blocks per record
10417 @opindex blocking-factor
10418 The data in an archive is grouped into blocks, which are 512 bytes.
10419 Blocks are read and written in whole number multiples called
10420 @dfn{records}. The number of blocks in a record (i.e., the size of a
10421 record in units of 512 bytes) is called the @dfn{blocking factor}.
10422 The @option{--blocking-factor=@var{512-size}} (@option{-b
10423 @var{512-size}}) option specifies the blocking factor of an archive.
10424 The default blocking factor is typically 20 (i.e., 10240 bytes), but
10425 can be specified at installation. To find out the blocking factor of
10426 an existing archive, use @samp{tar --list --file=@var{archive-name}}.
10427 This may not work on some devices.
10429 Records are separated by gaps, which waste space on the archive media.
10430 If you are archiving on magnetic tape, using a larger blocking factor
10431 (and therefore larger records) provides faster throughput and allows you
10432 to fit more data on a tape (because there are fewer gaps). If you are
10433 archiving on cartridge, a very large blocking factor (say 126 or more)
10434 greatly increases performance. A smaller blocking factor, on the other
10435 hand, may be useful when archiving small files, to avoid archiving lots
10436 of nulls as @command{tar} fills out the archive to the end of the record.
10437 In general, the ideal record size depends on the size of the
10438 inter-record gaps on the tape you are using, and the average size of the
10439 files you are archiving. @xref{create}, for information on
10442 @FIXME{Need example of using a cartridge with blocking factor=126 or more.}
10444 Archives with blocking factors larger than 20 cannot be read
10445 by very old versions of @command{tar}, or by some newer versions
10446 of @command{tar} running on old machines with small address spaces.
10447 With @GNUTAR{}, the blocking factor of an archive is limited
10448 only by the maximum record size of the device containing the archive,
10449 or by the amount of available virtual memory.
10451 Also, on some systems, not using adequate blocking factors, as sometimes
10452 imposed by the device drivers, may yield unexpected diagnostics. For
10453 example, this has been reported:
10456 Cannot write to /dev/dlt: Invalid argument
10460 In such cases, it sometimes happen that the @command{tar} bundled by
10461 the system is aware of block size idiosyncrasies, while @GNUTAR{}
10462 requires an explicit specification for the block size,
10463 which it cannot guess. This yields some people to consider
10464 @GNUTAR{} is misbehaving, because by comparison,
10465 @cite{the bundle @command{tar} works OK}. Adding @w{@kbd{-b 256}},
10466 for example, might resolve the problem.
10468 If you use a non-default blocking factor when you create an archive, you
10469 must specify the same blocking factor when you modify that archive. Some
10470 archive devices will also require you to specify the blocking factor when
10471 reading that archive, however this is not typically the case. Usually, you
10472 can use @option{--list} (@option{-t}) without specifying a blocking factor---@command{tar}
10473 reports a non-default record size and then lists the archive members as
10474 it would normally. To extract files from an archive with a non-standard
10475 blocking factor (particularly if you're not sure what the blocking factor
10476 is), you can usually use the @option{--read-full-records} (@option{-B}) option while
10477 specifying a blocking factor larger then the blocking factor of the archive
10478 (i.e., @samp{tar --extract --read-full-records --blocking-factor=300}.
10479 @xref{list}, for more information on the @option{--list} (@option{-t})
10480 operation. @xref{Reading}, for a more detailed explanation of that option.
10483 @item --blocking-factor=@var{number}
10484 @itemx -b @var{number}
10485 Specifies the blocking factor of an archive. Can be used with any
10486 operation, but is usually not necessary with @option{--list} (@option{-t}).
10492 @item -b @var{blocks}
10493 @itemx --blocking-factor=@var{blocks}
10494 Set record size to @math{@var{blocks} * 512} bytes.
10496 This option is used to specify a @dfn{blocking factor} for the archive.
10497 When reading or writing the archive, @command{tar}, will do reads and writes
10498 of the archive in records of @math{@var{block}*512} bytes. This is true
10499 even when the archive is compressed. Some devices requires that all
10500 write operations be a multiple of a certain size, and so, @command{tar}
10501 pads the archive out to the next record boundary.
10503 The default blocking factor is set when @command{tar} is compiled, and is
10504 typically 20. Blocking factors larger than 20 cannot be read by very
10505 old versions of @command{tar}, or by some newer versions of @command{tar}
10506 running on old machines with small address spaces.
10508 With a magnetic tape, larger records give faster throughput and fit
10509 more data on a tape (because there are fewer inter-record gaps).
10510 If the archive is in a disk file or a pipe, you may want to specify
10511 a smaller blocking factor, since a large one will result in a large
10512 number of null bytes at the end of the archive.
10514 When writing cartridge or other streaming tapes, a much larger
10515 blocking factor (say 126 or more) will greatly increase performance.
10516 However, you must specify the same blocking factor when reading or
10517 updating the archive.
10519 Apparently, Exabyte drives have a physical block size of 8K bytes.
10520 If we choose our blocksize as a multiple of 8k bytes, then the problem
10521 seems to disappear. Id est, we are using block size of 112 right
10522 now, and we haven't had the problem since we switched@dots{}
10524 With @GNUTAR{} the blocking factor is limited only
10525 by the maximum record size of the device containing the archive, or by
10526 the amount of available virtual memory.
10528 However, deblocking or reblocking is virtually avoided in a special
10529 case which often occurs in practice, but which requires all the
10530 following conditions to be simultaneously true:
10533 the archive is subject to a compression option,
10535 the archive is not handled through standard input or output, nor
10536 redirected nor piped,
10538 the archive is directly handled to a local disk, instead of any special
10541 @option{--blocking-factor} is not explicitly specified on the @command{tar}
10545 If the output goes directly to a local disk, and not through
10546 stdout, then the last write is not extended to a full record size.
10547 Otherwise, reblocking occurs. Here are a few other remarks on this
10553 @command{gzip} will complain about trailing garbage if asked to
10554 uncompress a compressed archive on tape, there is an option to turn
10555 the message off, but it breaks the regularity of simply having to use
10556 @samp{@var{prog} -d} for decompression. It would be nice if gzip was
10557 silently ignoring any number of trailing zeros. I'll ask Jean-loup
10558 Gailly, by sending a copy of this message to him.
10561 @command{compress} does not show this problem, but as Jean-loup pointed
10562 out to Michael, @samp{compress -d} silently adds garbage after
10563 the result of decompression, which tar ignores because it already
10564 recognized its end-of-file indicator. So this bug may be safely
10568 @samp{gzip -d -q} will be silent about the trailing zeros indeed,
10569 but will still return an exit status of 2 which tar reports in turn.
10570 @command{tar} might ignore the exit status returned, but I hate doing
10571 that, as it weakens the protection @command{tar} offers users against
10572 other possible problems at decompression time. If @command{gzip} was
10573 silently skipping trailing zeros @emph{and} also avoiding setting the
10574 exit status in this innocuous case, that would solve this situation.
10577 @command{tar} should become more solid at not stopping to read a pipe at
10578 the first null block encountered. This inelegantly breaks the pipe.
10579 @command{tar} should rather drain the pipe out before exiting itself.
10582 @xopindex{ignore-zeros, short description}
10584 @itemx --ignore-zeros
10585 Ignore blocks of zeros in archive (means EOF).
10587 The @option{--ignore-zeros} (@option{-i}) option causes @command{tar} to ignore blocks
10588 of zeros in the archive. Normally a block of zeros indicates the
10589 end of the archive, but when reading a damaged archive, or one which
10590 was created by concatenating several archives together, this option
10591 allows @command{tar} to read the entire archive. This option is not on
10592 by default because many versions of @command{tar} write garbage after
10595 Note that this option causes @command{tar} to read to the end of the
10596 archive file, which may sometimes avoid problems when multiple files
10597 are stored on a single physical tape.
10599 @xopindex{read-full-records, short description}
10601 @itemx --read-full-records
10602 Reblock as we read (for reading 4.2@acronym{BSD} pipes).
10604 If @option{--read-full-records} is used, @command{tar}
10605 will not panic if an attempt to read a record from the archive does
10606 not return a full record. Instead, @command{tar} will keep reading
10607 until it has obtained a full
10610 This option is turned on by default when @command{tar} is reading
10611 an archive from standard input, or from a remote machine. This is
10612 because on @acronym{BSD} Unix systems, a read of a pipe will return however
10613 much happens to be in the pipe, even if it is less than @command{tar}
10614 requested. If this option was not used, @command{tar} would fail as
10615 soon as it read an incomplete record from the pipe.
10617 This option is also useful with the commands for updating an archive.
10623 @FIXME{Appropriate options should be moved here from elsewhere.}
10625 @cindex blocking factor
10626 @cindex tape blocking
10628 When handling various tapes or cartridges, you have to take care of
10629 selecting a proper blocking, that is, the number of disk blocks you
10630 put together as a single tape block on the tape, without intervening
10631 tape gaps. A @dfn{tape gap} is a small landing area on the tape
10632 with no information on it, used for decelerating the tape to a
10633 full stop, and for later regaining the reading or writing speed.
10634 When the tape driver starts reading a record, the record has to
10635 be read whole without stopping, as a tape gap is needed to stop the
10636 tape motion without loosing information.
10638 @cindex Exabyte blocking
10639 @cindex DAT blocking
10640 Using higher blocking (putting more disk blocks per tape block) will use
10641 the tape more efficiently as there will be less tape gaps. But reading
10642 such tapes may be more difficult for the system, as more memory will be
10643 required to receive at once the whole record. Further, if there is a
10644 reading error on a huge record, this is less likely that the system will
10645 succeed in recovering the information. So, blocking should not be too
10646 low, nor it should be too high. @command{tar} uses by default a blocking of
10647 20 for historical reasons, and it does not really matter when reading or
10648 writing to disk. Current tape technology would easily accommodate higher
10649 blockings. Sun recommends a blocking of 126 for Exabytes and 96 for DATs.
10650 We were told that for some DLT drives, the blocking should be a multiple
10651 of 4Kb, preferably 64Kb (@w{@kbd{-b 128}}) or 256 for decent performance.
10652 Other manufacturers may use different recommendations for the same tapes.
10653 This might also depends of the buffering techniques used inside modern
10654 tape controllers. Some imposes a minimum blocking, or a maximum blocking.
10655 Others request blocking to be some exponent of two.
10657 So, there is no fixed rule for blocking. But blocking at read time
10658 should ideally be the same as blocking used at write time. At one place
10659 I know, with a wide variety of equipment, they found it best to use a
10660 blocking of 32 to guarantee that their tapes are fully interchangeable.
10662 I was also told that, for recycled tapes, prior erasure (by the same
10663 drive unit that will be used to create the archives) sometimes lowers
10664 the error rates observed at rewriting time.
10666 I might also use @option{--number-blocks} instead of
10667 @option{--block-number}, so @option{--block} will then expand to
10668 @option{--blocking-factor} unambiguously.
10671 @section Many Archives on One Tape
10673 @FIXME{Appropriate options should be moved here from elsewhere.}
10675 @findex ntape @r{device}
10676 Most tape devices have two entries in the @file{/dev} directory, or
10677 entries that come in pairs, which differ only in the minor number for
10678 this device. Let's take for example @file{/dev/tape}, which often
10679 points to the only or usual tape device of a given system. There might
10680 be a corresponding @file{/dev/nrtape} or @file{/dev/ntape}. The simpler
10681 name is the @emph{rewinding} version of the device, while the name
10682 having @samp{nr} in it is the @emph{no rewinding} version of the same
10685 A rewinding tape device will bring back the tape to its beginning point
10686 automatically when this device is opened or closed. Since @command{tar}
10687 opens the archive file before using it and closes it afterwards, this
10688 means that a simple:
10691 $ @kbd{tar cf /dev/tape @var{directory}}
10695 will reposition the tape to its beginning both prior and after saving
10696 @var{directory} contents to it, thus erasing prior tape contents and
10697 making it so that any subsequent write operation will destroy what has
10700 @cindex tape positioning
10701 So, a rewinding device is normally meant to hold one and only one file.
10702 If you want to put more than one @command{tar} archive on a given tape, you
10703 will need to avoid using the rewinding version of the tape device. You
10704 will also have to pay special attention to tape positioning. Errors in
10705 positioning may overwrite the valuable data already on your tape. Many
10706 people, burnt by past experiences, will only use rewinding devices and
10707 limit themselves to one file per tape, precisely to avoid the risk of
10708 such errors. Be fully aware that writing at the wrong position on a
10709 tape loses all information past this point and most probably until the
10710 end of the tape, and this destroyed information @emph{cannot} be
10713 To save @var{directory-1} as a first archive at the beginning of a
10714 tape, and leave that tape ready for a second archive, you should use:
10717 $ @kbd{mt -f /dev/nrtape rewind}
10718 $ @kbd{tar cf /dev/nrtape @var{directory-1}}
10722 @dfn{Tape marks} are special magnetic patterns written on the tape
10723 media, which are later recognizable by the reading hardware. These
10724 marks are used after each file, when there are many on a single tape.
10725 An empty file (that is to say, two tape marks in a row) signal the
10726 logical end of the tape, after which no file exist. Usually,
10727 non-rewinding tape device drivers will react to the close request issued
10728 by @command{tar} by first writing two tape marks after your archive, and by
10729 backspacing over one of these. So, if you remove the tape at that time
10730 from the tape drive, it is properly terminated. But if you write
10731 another file at the current position, the second tape mark will be
10732 erased by the new information, leaving only one tape mark between files.
10734 So, you may now save @var{directory-2} as a second archive after the
10735 first on the same tape by issuing the command:
10738 $ @kbd{tar cf /dev/nrtape @var{directory-2}}
10742 and so on for all the archives you want to put on the same tape.
10744 Another usual case is that you do not write all the archives the same
10745 day, and you need to remove and store the tape between two archive
10746 sessions. In general, you must remember how many files are already
10747 saved on your tape. Suppose your tape already has 16 files on it, and
10748 that you are ready to write the 17th. You have to take care of skipping
10749 the first 16 tape marks before saving @var{directory-17}, say, by using
10753 $ @kbd{mt -f /dev/nrtape rewind}
10754 $ @kbd{mt -f /dev/nrtape fsf 16}
10755 $ @kbd{tar cf /dev/nrtape @var{directory-17}}
10758 In all the previous examples, we put aside blocking considerations, but
10759 you should do the proper things for that as well. @xref{Blocking}.
10762 * Tape Positioning:: Tape Positions and Tape Marks
10763 * mt:: The @command{mt} Utility
10766 @node Tape Positioning
10767 @subsection Tape Positions and Tape Marks
10770 Just as archives can store more than one file from the file system,
10771 tapes can store more than one archive file. To keep track of where
10772 archive files (or any other type of file stored on tape) begin and
10773 end, tape archive devices write magnetic @dfn{tape marks} on the
10774 archive media. Tape drives write one tape mark between files,
10775 two at the end of all the file entries.
10777 If you think of data as a series of records "rrrr"'s, and tape marks as
10778 "*"'s, a tape might look like the following:
10781 rrrr*rrrrrr*rrrrr*rr*rrrrr**-------------------------
10784 Tape devices read and write tapes using a read/write @dfn{tape
10785 head}---a physical part of the device which can only access one
10786 point on the tape at a time. When you use @command{tar} to read or
10787 write archive data from a tape device, the device will begin reading
10788 or writing from wherever on the tape the tape head happens to be,
10789 regardless of which archive or what part of the archive the tape
10790 head is on. Before writing an archive, you should make sure that no
10791 data on the tape will be overwritten (unless it is no longer needed).
10792 Before reading an archive, you should make sure the tape head is at
10793 the beginning of the archive you want to read. You can do it manually
10794 via @code{mt} utility (@pxref{mt}). The @code{restore} script does
10795 that automatically (@pxref{Scripted Restoration}).
10797 If you want to add new archive file entries to a tape, you should
10798 advance the tape to the end of the existing file entries, backspace
10799 over the last tape mark, and write the new archive file. If you were
10800 to add two archives to the example above, the tape might look like the
10804 rrrr*rrrrrr*rrrrr*rr*rrrrr*rrr*rrrr**----------------
10808 @subsection The @command{mt} Utility
10811 @FIXME{Is it true that this only works on non-block devices?
10812 should explain the difference, (fixed or variable).}
10813 @xref{Blocking Factor}.
10815 You can use the @command{mt} utility to advance or rewind a tape past a
10816 specified number of archive files on the tape. This will allow you
10817 to move to the beginning of an archive before extracting or reading
10818 it, or to the end of all the archives before writing a new one.
10819 @FIXME{Why isn't there an "advance 'til you find two tape marks
10822 The syntax of the @command{mt} command is:
10825 @kbd{mt [-f @var{tapename}] @var{operation} [@var{number}]}
10828 where @var{tapename} is the name of the tape device, @var{number} is
10829 the number of times an operation is performed (with a default of one),
10830 and @var{operation} is one of the following:
10832 @FIXME{is there any use for record operations?}
10837 Writes @var{number} tape marks at the current position on the tape.
10840 Moves tape position forward @var{number} files.
10843 Moves tape position back @var{number} files.
10846 Rewinds the tape. (Ignores @var{number}).
10850 Rewinds the tape and takes the tape device off-line. (Ignores @var{number}).
10853 Prints status information about the tape unit.
10857 If you don't specify a @var{tapename}, @command{mt} uses the environment
10858 variable @env{TAPE}; if @env{TAPE} is not set, @command{mt} will use
10859 the default device specified in your @file{sys/mtio.h} file
10860 (@code{DEFTAPE} variable). If this is not defined, the program will
10861 display a descriptive error message and exit with code 1.
10863 @command{mt} returns a 0 exit status when the operation(s) were
10864 successful, 1 if the command was unrecognized, and 2 if an operation
10867 @node Using Multiple Tapes
10868 @section Using Multiple Tapes
10870 Often you might want to write a large archive, one larger than will fit
10871 on the actual tape you are using. In such a case, you can run multiple
10872 @command{tar} commands, but this can be inconvenient, particularly if you
10873 are using options like @option{--exclude=@var{pattern}} or dumping entire file systems.
10874 Therefore, @command{tar} provides a special mode for creating
10875 multi-volume archives.
10877 @dfn{Multi-volume} archive is a single @command{tar} archive, stored
10878 on several media volumes of fixed size. Although in this section we will
10879 often call @samp{volume} a @dfn{tape}, there is absolutely no
10880 requirement for multi-volume archives to be stored on tapes. Instead,
10881 they can use whatever media type the user finds convenient, they can
10882 even be located on files.
10884 When creating a multi-volume archive, @GNUTAR{} continues to fill
10885 current volume until it runs out of space, then it switches to
10886 next volume (usually the operator is queried to replace the tape on
10887 this point), and continues working on the new volume. This operation
10888 continues until all requested files are dumped. If @GNUTAR{} detects
10889 end of media while dumping a file, such a file is archived in split
10890 form. Some very big files can even be split across several volumes.
10892 Each volume is itself a valid @GNUTAR{} archive, so it can be read
10893 without any special options. Consequently any file member residing
10894 entirely on one volume can be extracted or otherwise operated upon
10895 without needing the other volume. Sure enough, to extract a split
10896 member you would need all volumes its parts reside on.
10898 Multi-volume archives suffer from several limitations. In particular,
10899 they cannot be compressed.
10901 @GNUTAR{} is able to create multi-volume archives of two formats
10902 (@pxref{Formats}): @samp{GNU} and @samp{POSIX}.
10905 * Multi-Volume Archives:: Archives Longer than One Tape or Disk
10906 * Tape Files:: Tape Files
10907 * Tarcat:: Concatenate Volumes into a Single Archive
10911 @node Multi-Volume Archives
10912 @subsection Archives Longer than One Tape or Disk
10913 @cindex Multi-volume archives
10915 @opindex multi-volume
10916 To create an archive that is larger than will fit on a single unit of
10917 the media, use the @option{--multi-volume} (@option{-M}) option in conjunction with
10918 the @option{--create} option (@pxref{create}). A @dfn{multi-volume}
10919 archive can be manipulated like any other archive (provided the
10920 @option{--multi-volume} option is specified), but is stored on more
10921 than one tape or disk.
10923 When you specify @option{--multi-volume}, @command{tar} does not report an
10924 error when it comes to the end of an archive volume (when reading), or
10925 the end of the media (when writing). Instead, it prompts you to load
10926 a new storage volume. If the archive is on a magnetic tape, you
10927 should change tapes when you see the prompt; if the archive is on a
10928 floppy disk, you should change disks; etc.
10931 @item --multi-volume
10933 Creates a multi-volume archive, when used in conjunction with
10934 @option{--create} (@option{-c}). To perform any other operation on a multi-volume
10935 archive, specify @option{--multi-volume} in conjunction with that
10940 $ @kbd{tar --create --multi-volume --file=/dev/tape @var{files}}
10944 The method @command{tar} uses to detect end of tape is not perfect, and
10945 fails on some operating systems or on some devices. If @command{tar}
10946 cannot detect the end of the tape itself, you can use
10947 @option{--tape-length} option to inform it about the capacity of the
10950 @anchor{tape-length}
10952 @opindex tape-length
10953 @item --tape-length=@var{size}
10954 @itemx -L @var{size}
10955 Set maximum length of a volume. The @var{size} argument should then
10956 be the usable size of the tape in units of 1024 bytes. This option
10957 selects @option{--multi-volume} automatically. For example:
10960 $ @kbd{tar --create --tape-length=41943040 --file=/dev/tape @var{files}}
10964 @anchor{change volume prompt}
10965 When @GNUTAR{} comes to the end of a storage media, it asks you to
10966 change the volume. The built-in prompt for POSIX locale
10967 is@footnote{If you run @GNUTAR{} under a different locale, the
10968 translation to the locale's language will be used.}:
10971 Prepare volume #@var{n} for `@var{archive}' and hit return:
10975 where @var{n} is the ordinal number of the volume to be created and
10976 @var{archive} is archive file or device name.
10978 When prompting for a new tape, @command{tar} accepts any of the following
10983 Request @command{tar} to explain possible responses
10985 Request @command{tar} to exit immediately.
10986 @item n @var{file-name}
10987 Request @command{tar} to write the next volume on the file @var{file-name}.
10989 Request @command{tar} to run a subshell. This option can be disabled
10990 by giving @option{--restrict} command line option to
10991 @command{tar}@footnote{@xref{--restrict}, for more information about
10994 Request @command{tar} to begin writing the next volume.
10997 (You should only type @samp{y} after you have changed the tape;
10998 otherwise @command{tar} will write over the volume it just finished.)
11000 @cindex Volume number file
11002 @anchor{volno-file}
11003 @opindex volno-file
11004 The volume number used by @command{tar} in its tape-changing prompt
11005 can be changed; if you give the
11006 @option{--volno-file=@var{file-of-number}} option, then
11007 @var{file-of-number} should be an non-existing file to be created, or
11008 else, a file already containing a decimal number. That number will be
11009 used as the volume number of the first volume written. When
11010 @command{tar} is finished, it will rewrite the file with the
11011 now-current volume number. (This does not change the volume number
11012 written on a tape label, as per @ref{label}, it @emph{only} affects
11013 the number used in the prompt.)
11015 @cindex End-of-archive info script
11016 @cindex Info script
11017 @anchor{info-script}
11018 @opindex info-script
11019 @opindex new-volume-script
11020 If you want more elaborate behavior than this, you can write a special
11021 @dfn{new volume script}, that will be responsible for changing the
11022 volume, and instruct @command{tar} to use it instead of its normal
11023 prompting procedure:
11026 @item --info-script=@var{script-name}
11027 @itemx --new-volume-script=@var{script-name}
11028 @itemx -F @var{script-name}
11029 Specify the full name of the volume script to use. The script can be
11030 used to eject cassettes, or to broadcast messages such as
11031 @samp{Someone please come change my tape} when performing unattended
11035 The @var{script-name} is executed without any command line
11036 arguments. It inherits @command{tar}'s shell environment.
11037 Additional data is passed to it via the following
11038 environment variables:
11041 @vrindex TAR_VERSION, info script environment variable
11043 @GNUTAR{} version number.
11045 @vrindex TAR_ARCHIVE, info script environment variable
11047 The name of the archive @command{tar} is processing.
11049 @vrindex TAR_BLOCKING_FACTOR, info script environment variable
11050 @item TAR_BLOCKING_FACTOR
11051 Current blocking factor (@pxref{Blocking}.
11053 @vrindex TAR_VOLUME, info script environment variable
11055 Ordinal number of the volume @command{tar} is about to start.
11057 @vrindex TAR_SUBCOMMAND, info script environment variable
11058 @item TAR_SUBCOMMAND
11059 A short option describing the operation @command{tar} is executing
11060 @xref{Operations}, for a complete list of subcommand options.
11062 @vrindex TAR_FORMAT, info script environment variable
11064 Format of the archive being processed. @xref{Formats}, for a complete
11065 list of archive format names.
11067 @vrindex TAR_FD, info script environment variable
11069 File descriptor which can be used to communicate the new volume
11070 name to @command{tar}.
11073 The volume script can instruct @command{tar} to use new archive name,
11074 by writing in to file descriptor @env{$TAR_FD} (see below for an example).
11076 If the info script fails, @command{tar} exits; otherwise, it begins
11077 writing the next volume.
11079 If you want @command{tar} to cycle through a series of files or tape
11080 drives, there are three approaches to choose from. First of all, you
11081 can give @command{tar} multiple @option{--file} options. In this case
11082 the specified files will be used, in sequence, as the successive
11083 volumes of the archive. Only when the first one in the sequence needs
11084 to be used again will @command{tar} prompt for a tape change (or run
11085 the info script). For example, suppose someone has two tape drives on
11086 a system named @file{/dev/tape0} and @file{/dev/tape1}. For having
11087 @GNUTAR{} to switch to the second drive when it needs to write the
11088 second tape, and then back to the first tape, etc., just do either of:
11091 $ @kbd{tar --create --multi-volume --file=/dev/tape0 --file=/dev/tape1 @var{files}}
11092 $ @kbd{tar cMff /dev/tape0 /dev/tape1 @var{files}}
11095 The second method is to use the @samp{n} response to the tape-change
11098 Finally, the most flexible approach is to use a volume script, that
11099 writes new archive name to the file descriptor @env{$TAR_FD}. For example, the
11100 following volume script will create a series of archive files, named
11101 @file{@var{archive}-@var{vol}}, where @var{archive} is the name of the
11102 archive being created (as given by @option{--file} option) and
11103 @var{vol} is the ordinal number of the archive being created:
11108 echo Preparing volume $TAR_VOLUME of $TAR_ARCHIVE.
11110 name=`expr $TAR_ARCHIVE : '\(.*\)-.*'`
11111 case $TAR_SUBCOMMAND in
11113 -d|-x|-t) test -r $@{name:-$TAR_ARCHIVE@}-$TAR_VOLUME || exit 1
11118 echo $@{name:-$TAR_ARCHIVE@}-$TAR_VOLUME >&$TAR_FD
11122 The same script can be used while listing, comparing or extracting
11123 from the created archive. For example:
11127 # @r{Create a multi-volume archive:}
11128 $ @kbd{tar -c -L1024 -f archive.tar -F new-volume .}
11129 # @r{Extract from the created archive:}
11130 $ @kbd{tar -x -f archive.tar -F new-volume .}
11135 Notice, that the first command had to use @option{-L} option, since
11136 otherwise @GNUTAR{} will end up writing everything to file
11137 @file{archive.tar}.
11139 You can read each individual volume of a multi-volume archive as if it
11140 were an archive by itself. For example, to list the contents of one
11141 volume, use @option{--list}, without @option{--multi-volume} specified.
11142 To extract an archive member from one volume (assuming it is described
11143 that volume), use @option{--extract}, again without
11144 @option{--multi-volume}.
11146 If an archive member is split across volumes (i.e., its entry begins on
11147 one volume of the media and ends on another), you need to specify
11148 @option{--multi-volume} to extract it successfully. In this case, you
11149 should load the volume where the archive member starts, and use
11150 @samp{tar --extract --multi-volume}---@command{tar} will prompt for later
11151 volumes as it needs them. @xref{extracting archives}, for more
11152 information about extracting archives.
11154 Multi-volume archives can be modified like any other archive. To add
11155 files to a multi-volume archive, you need to only mount the last
11156 volume of the archive media (and new volumes, if needed). For all
11157 other operations, you need to use the entire archive.
11159 If a multi-volume archive was labeled using
11160 @option{--label=@var{archive-label}} (@pxref{label}) when it was
11161 created, @command{tar} will not automatically label volumes which are
11162 added later. To label subsequent volumes, specify
11163 @option{--label=@var{archive-label}} again in conjunction with the
11164 @option{--append}, @option{--update} or @option{--concatenate} operation.
11166 Notice that multi-volume support is a GNU extension and the archives
11167 created in this mode should be read only using @GNUTAR{}. If you
11168 absolutely have to process such archives using a third-party @command{tar}
11169 implementation, read @ref{Split Recovery}.
11172 @subsection Tape Files
11173 @cindex labeling archives
11177 To give the archive a name which will be recorded in it, use the
11178 @option{--label=@var{volume-label}} (@option{-V @var{volume-label}})
11179 option. This will write a special block identifying
11180 @var{volume-label} as the name of the archive to the front of the
11181 archive which will be displayed when the archive is listed with
11182 @option{--list}. If you are creating a multi-volume archive with
11183 @option{--multi-volume} (@pxref{Using Multiple Tapes}), then the
11184 volume label will have @samp{Volume @var{nnn}} appended to the name
11185 you give, where @var{nnn} is the number of the volume of the archive.
11186 (If you use the @option{--label=@var{volume-label}}) option when
11187 reading an archive, it checks to make sure the label on the tape
11188 matches the one you give. @xref{label}.
11190 When @command{tar} writes an archive to tape, it creates a single
11191 tape file. If multiple archives are written to the same tape, one
11192 after the other, they each get written as separate tape files. When
11193 extracting, it is necessary to position the tape at the right place
11194 before running @command{tar}. To do this, use the @command{mt} command.
11195 For more information on the @command{mt} command and on the organization
11196 of tapes into a sequence of tape files, see @ref{mt}.
11198 People seem to often do:
11201 @kbd{--label="@var{some-prefix} `date +@var{some-format}`"}
11204 or such, for pushing a common date in all volumes or an archive set.
11207 @subsection Concatenate Volumes into a Single Archive
11210 Sometimes it is necessary to convert existing @GNUTAR{} multi-volume
11211 archive to a single @command{tar} archive. Simply concatenating all
11212 volumes into one will not work, since each volume carries an additional
11213 information at the beginning. @GNUTAR{} is shipped with the shell
11214 script @command{tarcat} designed for this purpose.
11216 The script takes a list of files comprising a multi-volume archive
11217 and creates the resulting archive at the standard output. For example:
11220 @kbd{tarcat vol.1 vol.2 vol.3 | tar tf -}
11223 The script implements a simple heuristics to determine the format of
11224 the first volume file and to decide how to process the rest of the
11225 files. However, it makes no attempt to verify whether the files are
11226 given in order or even if they are valid @command{tar} archives.
11227 It uses @command{dd} and does not filter its standard error, so you
11228 will usually see lots of spurious messages.
11230 @FIXME{The script is not installed. Should we install it?}
11233 @section Including a Label in the Archive
11234 @cindex Labeling an archive
11235 @cindex Labels on the archive media
11236 @cindex Labeling multi-volume archives
11240 To avoid problems caused by misplaced paper labels on the archive
11241 media, you can include a @dfn{label} entry---an archive member which
11242 contains the name of the archive---in the archive itself. Use the
11243 @option{--label=@var{archive-label}} (@option{-V @var{archive-label}})
11244 option in conjunction with the @option{--create} operation to include
11245 a label entry in the archive as it is being created.
11248 @item --label=@var{archive-label}
11249 @itemx -V @var{archive-label}
11250 Includes an @dfn{archive-label} at the beginning of the archive when
11251 the archive is being created, when used in conjunction with the
11252 @option{--create} operation. Checks to make sure the archive label
11253 matches the one specified (when used in conjunction with any other
11257 If you create an archive using both
11258 @option{--label=@var{archive-label}} (@option{-V @var{archive-label}})
11259 and @option{--multi-volume} (@option{-M}), each volume of the archive
11260 will have an archive label of the form @samp{@var{archive-label}
11261 Volume @var{n}}, where @var{n} is 1 for the first volume, 2 for the
11262 next, and so on. @xref{Using Multiple Tapes}, for information on
11263 creating multiple volume archives.
11265 @cindex Volume label, listing
11266 @cindex Listing volume label
11267 The volume label will be displayed by @option{--list} along with
11268 the file contents. If verbose display is requested, it will also be
11269 explicitly marked as in the example below:
11273 $ @kbd{tar --verbose --list --file=iamanarchive}
11274 V--------- 0 0 0 1992-03-07 12:01 iamalabel--Volume Header--
11275 -rw-r--r-- ringo user 40 1990-05-21 13:30 iamafilename
11279 @opindex test-label
11280 @anchor{--test-label option}
11281 However, @option{--list} option will cause listing entire
11282 contents of the archive, which may be undesirable (for example, if the
11283 archive is stored on a tape). You can request checking only the volume
11284 by specifying @option{--test-label} option. This option reads only the
11285 first block of an archive, so it can be used with slow storage
11286 devices. For example:
11290 $ @kbd{tar --test-label --file=iamanarchive}
11295 If @option{--test-label} is used with a single command line
11296 argument, @command{tar} compares the volume label with the
11297 argument. It exits with code 0 if the two strings match, and with code
11298 2 otherwise. In this case no output is displayed. For example:
11302 $ @kbd{tar --test-label --file=iamanarchive 'iamalable'}
11304 $ @kbd{tar --test-label --file=iamanarchive 'iamalable' alabel}
11309 If you request any operation, other than @option{--create}, along
11310 with using @option{--label} option, @command{tar} will first check if
11311 the archive label matches the one specified and will refuse to proceed
11312 if it does not. Use this as a safety precaution to avoid accidentally
11313 overwriting existing archives. For example, if you wish to add files
11314 to @file{archive}, presumably labeled with string @samp{My volume},
11319 $ @kbd{tar -rf archive --label 'My volume' .}
11320 tar: Archive not labeled to match `My volume'
11325 in case its label does not match. This will work even if
11326 @file{archive} is not labeled at all.
11328 Similarly, @command{tar} will refuse to list or extract the
11329 archive if its label doesn't match the @var{archive-label}
11330 specified. In those cases, @var{archive-label} argument is interpreted
11331 as a globbing-style pattern which must match the actual magnetic
11332 volume label. @xref{exclude}, for a precise description of how match
11333 is attempted@footnote{Previous versions of @command{tar} used full
11334 regular expression matching, or before that, only exact string
11335 matching, instead of wildcard matchers. We decided for the sake of
11336 simplicity to use a uniform matching device through
11337 @command{tar}.}. If the switch @option{--multi-volume} (@option{-M}) is being used,
11338 the volume label matcher will also suffix @var{archive-label} by
11339 @w{@samp{ Volume [1-9]*}} if the initial match fails, before giving
11340 up. Since the volume numbering is automatically added in labels at
11341 creation time, it sounded logical to equally help the user taking care
11342 of it when the archive is being read.
11344 The @option{--label} was once called @option{--volume}, but is not
11345 available under that name anymore.
11347 You can also use @option{--label} to get a common information on
11348 all tapes of a series. For having this information different in each
11349 series created through a single script used on a regular basis, just
11350 manage to get some date string as part of the label. For example:
11354 $ @kbd{tar cfMV /dev/tape "Daily backup for `date +%Y-%m-%d`"}
11355 $ @kbd{tar --create --file=/dev/tape --multi-volume \
11356 --volume="Daily backup for `date +%Y-%m-%d`"}
11360 Also note that each label has its own date and time, which corresponds
11361 to when @GNUTAR{} initially attempted to write it,
11362 often soon after the operator launches @command{tar} or types the
11363 carriage return telling that the next tape is ready. Comparing date
11364 labels does give an idea of tape throughput only if the delays for
11365 rewinding tapes and the operator switching them were negligible, which
11366 is usually not the case.
11369 @section Verifying Data as It is Stored
11370 @cindex Verifying a write operation
11371 @cindex Double-checking a write operation
11376 @opindex verify, short description
11377 Attempt to verify the archive after writing.
11380 This option causes @command{tar} to verify the archive after writing it.
11381 Each volume is checked after it is written, and any discrepancies
11382 are recorded on the standard error output.
11384 Verification requires that the archive be on a back-space-able medium.
11385 This means pipes, some cartridge tape drives, and some other devices
11386 cannot be verified.
11388 You can insure the accuracy of an archive by comparing files in the
11389 system with archive members. @command{tar} can compare an archive to the
11390 file system as the archive is being written, to verify a write
11391 operation, or can compare a previously written archive, to insure that
11394 @xopindex{verify, using with @option{--create}}
11395 @xopindex{create, using with @option{--verify}}
11396 To check for discrepancies in an archive immediately after it is
11397 written, use the @option{--verify} (@option{-W}) option in conjunction with
11398 the @option{--create} operation. When this option is
11399 specified, @command{tar} checks archive members against their counterparts
11400 in the file system, and reports discrepancies on the standard error.
11402 To verify an archive, you must be able to read it from before the end
11403 of the last written entry. This option is useful for detecting data
11404 errors on some tapes. Archives written to pipes, some cartridge tape
11405 drives, and some other devices cannot be verified.
11407 One can explicitly compare an already made archive with the file
11408 system by using the @option{--compare} (@option{--diff}, @option{-d})
11409 option, instead of using the more automatic @option{--verify} option.
11412 Note that these two options have a slightly different intent. The
11413 @option{--compare} option checks how identical are the logical contents of some
11414 archive with what is on your disks, while the @option{--verify} option is
11415 really for checking if the physical contents agree and if the recording
11416 media itself is of dependable quality. So, for the @option{--verify}
11417 operation, @command{tar} tries to defeat all in-memory cache pertaining to
11418 the archive, while it lets the speed optimization undisturbed for the
11419 @option{--compare} option. If you nevertheless use @option{--compare} for
11420 media verification, you may have to defeat the in-memory cache yourself,
11421 maybe by opening and reclosing the door latch of your recording unit,
11422 forcing some doubt in your operating system about the fact this is really
11423 the same volume as the one just written or read.
11425 The @option{--verify} option would not be necessary if drivers were indeed
11426 able to detect dependably all write failures. This sometimes require many
11427 magnetic heads, some able to read after the writes occurred. One would
11428 not say that drivers unable to detect all cases are necessarily flawed,
11429 as long as programming is concerned.
11431 The @option{--verify} (@option{-W}) option will not work in
11432 conjunction with the @option{--multi-volume} (@option{-M}) option or
11433 the @option{--append} (@option{-r}), @option{--update} (@option{-u})
11434 and @option{--delete} operations. @xref{Operations}, for more
11435 information on these operations.
11437 Also, since @command{tar} normally strips leading @samp{/} from file
11438 names (@pxref{absolute}), a command like @samp{tar --verify -cf
11439 /tmp/foo.tar /etc} will work as desired only if the working directory is
11440 @file{/}, as @command{tar} uses the archive's relative member names
11441 (e.g., @file{etc/motd}) when verifying the archive.
11443 @node Write Protection
11444 @section Write Protection
11446 Almost all tapes and diskettes, and in a few rare cases, even disks can
11447 be @dfn{write protected}, to protect data on them from being changed.
11448 Once an archive is written, you should write protect the media to prevent
11449 the archive from being accidentally overwritten or deleted. (This will
11450 protect the archive from being changed with a tape or floppy drive---it
11451 will not protect it from magnet fields or other physical hazards).
11453 The write protection device itself is usually an integral part of the
11454 physical media, and can be a two position (write enabled/write
11455 disabled) switch, a notch which can be popped out or covered, a ring
11456 which can be removed from the center of a tape reel, or some other
11457 changeable feature.
11462 This appendix lists some important user-visible changes between
11463 version @GNUTAR{} @value{VERSION} and previous versions. An up-to-date
11464 version of this document is available at
11465 @uref{http://www.gnu.org/@/software/@/tar/manual/changes.html,the
11466 @GNUTAR{} documentation page}.
11469 @item Use of globbing patterns when listing and extracting.
11471 Previous versions of GNU tar assumed shell-style globbing when
11472 extracting from or listing an archive. For example:
11475 $ @kbd{tar xf foo.tar '*.c'}
11478 would extract all files whose names end in @samp{.c}. This behavior
11479 was not documented and was incompatible with traditional tar
11480 implementations. Therefore, starting from version 1.15.91, GNU tar
11481 no longer uses globbing by default. For example, the above invocation
11482 is now interpreted as a request to extract from the archive the file
11485 To facilitate transition to the new behavior for those users who got
11486 used to the previous incorrect one, @command{tar} will print a warning
11487 if it finds out that a requested member was not found in the archive
11488 and its name looks like a globbing pattern. For example:
11491 $ @kbd{tar xf foo.tar '*.c'}
11492 tar: Pattern matching characters used in file names. Please,
11493 tar: use --wildcards to enable pattern matching, or --no-wildcards to
11494 tar: suppress this warning.
11495 tar: *.c: Not found in archive
11496 tar: Error exit delayed from previous errors
11499 To treat member names as globbing patterns, use --wildcards option.
11500 If you want to tar to mimic the behavior of versions prior to 1.15.91,
11501 add this option to your @env{TAR_OPTIONS} variable.
11503 @xref{wildcards}, for the detailed discussion of the use of globbing
11504 patterns by @GNUTAR{}.
11506 @item Use of short option @option{-o}.
11508 Earlier versions of @GNUTAR{} understood @option{-o} command line
11509 option as a synonym for @option{--old-archive}.
11511 @GNUTAR{} starting from version 1.13.90 understands this option as
11512 a synonym for @option{--no-same-owner}. This is compatible with
11513 UNIX98 @command{tar} implementations.
11515 However, to facilitate transition, @option{-o} option retains its
11516 old semantics when it is used with one of archive-creation commands.
11517 Users are encouraged to use @option{--format=oldgnu} instead.
11519 It is especially important, since versions of @acronym{GNU} Automake
11520 up to and including 1.8.4 invoke tar with this option to produce
11521 distribution tarballs. @xref{Formats,v7}, for the detailed discussion
11522 of this issue and its implications.
11524 @xref{Options, tar-formats, Changing Automake's Behavior,
11525 automake, GNU Automake}, for a description on how to use various
11526 archive formats with @command{automake}.
11528 Future versions of @GNUTAR{} will understand @option{-o} only as a
11529 synonym for @option{--no-same-owner}.
11531 @item Use of short option @option{-l}
11533 Earlier versions of @GNUTAR{} understood @option{-l} option as a
11534 synonym for @option{--one-file-system}. Since such usage contradicted
11535 to UNIX98 specification and harmed compatibility with other
11536 implementation, it was declared deprecated in version 1.14. However,
11537 to facilitate transition to its new semantics, it was supported by
11538 versions 1.15 and 1.15.90. The present use of @option{-l} as a short
11539 variant of @option{--check-links} was introduced in version 1.15.91.
11541 @item Use of options @option{--portability} and @option{--old-archive}
11543 These options are deprecated. Please use @option{--format=v7} instead.
11545 @item Use of option @option{--posix}
11547 This option is deprecated. Please use @option{--format=posix} instead.
11550 @node Configuring Help Summary
11551 @appendix Configuring Help Summary
11553 Running @kbd{tar --help} displays the short @command{tar} option
11554 summary (@pxref{help}). This summary is organized by @dfn{groups} of
11555 semantically close options. The options within each group are printed
11556 in the following order: a short option, eventually followed by a list
11557 of corresponding long option names, followed by a short description of
11558 the option. For example, here is an excerpt from the actual @kbd{tar
11562 Main operation mode:
11564 -A, --catenate, --concatenate append tar files to an archive
11565 -c, --create create a new archive
11566 -d, --diff, --compare find differences between archive and
11568 --delete delete from the archive
11571 @vrindex ARGP_HELP_FMT, environment variable
11572 The exact visual representation of the help output is configurable via
11573 @env{ARGP_HELP_FMT} environment variable. The value of this variable
11574 is a comma-separated list of @dfn{format variable} assignments. There
11575 are two kinds of format variables. An @dfn{offset variable} keeps the
11576 offset of some part of help output text from the leftmost column on
11577 the screen. A @dfn{boolean} variable is a flag that toggles some
11578 output feature on or off. Depending on the type of the corresponding
11579 variable, there are two kinds of assignments:
11582 @item Offset assignment
11584 The assignment to an offset variable has the following syntax:
11587 @var{variable}=@var{value}
11591 where @var{variable} is the variable name, and @var{value} is a
11592 numeric value to be assigned to the variable.
11594 @item Boolean assignment
11596 To assign @code{true} value to a variable, simply put this variable name. To
11597 assign @code{false} value, prefix the variable name with @samp{no-}. For
11602 # Assign @code{true} value:
11604 # Assign @code{false} value:
11610 Following variables are declared:
11612 @deftypevr {Help Output} boolean dup-args
11613 If true, arguments for an option are shown with both short and long
11614 options, even when a given option has both forms, for example:
11617 -f ARCHIVE, --file=ARCHIVE use archive file or device ARCHIVE
11620 If false, then if an option has both short and long forms, the
11621 argument is only shown with the long one, for example:
11624 -f, --file=ARCHIVE use archive file or device ARCHIVE
11628 and a message indicating that the argument is applicable to both
11629 forms is printed below the options. This message can be disabled
11630 using @code{dup-args-note} (see below).
11632 The default is false.
11635 @deftypevr {Help Output} boolean dup-args-note
11636 If this variable is true, which is the default, the following notice
11637 is displayed at the end of the help output:
11640 Mandatory or optional arguments to long options are also mandatory or
11641 optional for any corresponding short options.
11644 Setting @code{no-dup-args-note} inhibits this message. Normally, only one of
11645 variables @code{dup-args} or @code{dup-args-note} should be set.
11648 @deftypevr {Help Output} offset short-opt-col
11649 Column in which short options start. Default is 2.
11653 $ @kbd{tar --help|grep ARCHIVE}
11654 -f, --file=ARCHIVE use archive file or device ARCHIVE
11655 $ @kbd{ARGP_HELP_FMT=short-opt-col=6 tar --help|grep ARCHIVE}
11656 -f, --file=ARCHIVE use archive file or device ARCHIVE
11661 @deftypevr {Help Output} offset long-opt-col
11662 Column in which long options start. Default is 6. For example:
11666 $ @kbd{tar --help|grep ARCHIVE}
11667 -f, --file=ARCHIVE use archive file or device ARCHIVE
11668 $ @kbd{ARGP_HELP_FMT=long-opt-col=16 tar --help|grep ARCHIVE}
11669 -f, --file=ARCHIVE use archive file or device ARCHIVE
11674 @deftypevr {Help Output} offset doc-opt-col
11675 Column in which @dfn{doc options} start. A doc option isn't actually
11676 an option, but rather an arbitrary piece of documentation that is
11677 displayed in much the same manner as the options. For example, in
11678 the description of @option{--format} option:
11682 -H, --format=FORMAT create archive of the given format.
11684 FORMAT is one of the following:
11686 gnu GNU tar 1.13.x format
11687 oldgnu GNU format as per tar <= 1.12
11688 pax POSIX 1003.1-2001 (pax) format
11690 ustar POSIX 1003.1-1988 (ustar) format
11691 v7 old V7 tar format
11696 the format names are doc options. Thus, if you set
11697 @kbd{ARGP_HELP_FMT=doc-opt-col=6} the above part of the help output
11698 will look as follows:
11702 -H, --format=FORMAT create archive of the given format.
11704 FORMAT is one of the following:
11706 gnu GNU tar 1.13.x format
11707 oldgnu GNU format as per tar <= 1.12
11708 pax POSIX 1003.1-2001 (pax) format
11710 ustar POSIX 1003.1-1988 (ustar) format
11711 v7 old V7 tar format
11716 @deftypevr {Help Output} offset opt-doc-col
11717 Column in which option description starts. Default is 29.
11721 $ @kbd{tar --help|grep ARCHIVE}
11722 -f, --file=ARCHIVE use archive file or device ARCHIVE
11723 $ @kbd{ARGP_HELP_FMT=opt-doc-col=19 tar --help|grep ARCHIVE}
11724 -f, --file=ARCHIVE use archive file or device ARCHIVE
11725 $ @kbd{ARGP_HELP_FMT=opt-doc-col=9 tar --help|grep ARCHIVE}
11727 use archive file or device ARCHIVE
11732 Notice, that the description starts on a separate line if
11733 @code{opt-doc-col} value is too small.
11736 @deftypevr {Help Output} offset header-col
11737 Column in which @dfn{group headers} are printed. A group header is a
11738 descriptive text preceding an option group. For example, in the
11742 Main operation mode:
11744 -A, --catenate, --concatenate append tar files to
11746 -c, --create create a new archive
11749 @samp{Main operation mode:} is the group header.
11751 The default value is 1.
11754 @deftypevr {Help Output} offset usage-indent
11755 Indentation of wrapped usage lines. Affects @option{--usage}
11756 output. Default is 12.
11759 @deftypevr {Help Output} offset rmargin
11760 Right margin of the text output. Used for wrapping.
11763 @node Fixing Snapshot Files
11764 @appendix Fixing Snapshot Files
11765 @include tar-snapshot-edit.texi
11767 @node Tar Internals
11768 @appendix Tar Internals
11769 @include intern.texi
11773 @include genfile.texi
11775 @node Free Software Needs Free Documentation
11776 @appendix Free Software Needs Free Documentation
11777 @include freemanuals.texi
11779 @node Copying This Manual
11780 @appendix Copying This Manual
11783 * GNU Free Documentation License:: License for copying this manual
11788 @node Index of Command Line Options
11789 @appendix Index of Command Line Options
11791 This appendix contains an index of all @GNUTAR{} long command line
11792 options. The options are listed without the preceding double-dash.
11793 For a cross-reference of short command line options, @ref{Short Option Summary}.
11806 @c Local variables:
11807 @c texinfo-column-for-description: 32
projects / chaz / tar / blob