OS Manuals

/usr/bin/tar

The GNU Tar program

From gnutar 1.35-r15 (os), captured 2026-11-05 by running tar --help (exit 0). permalink

Usage: tar [OPTION...] [FILE]...
GNU 'tar' saves many files together into a single tape or disk archive, and can
restore individual files from the archive.

Examples:
  tar -cf archive.tar foo bar  # Create archive.tar from files foo and bar.
  tar -tvf archive.tar         # List all files in archive.tar verbosely.
  tar -xf archive.tar          # Extract all files from archive.tar.

 Main operation mode:
  -A, --catenate, --concatenate   append tar files to an archive
  -c, --create               create a new archive
      --delete               delete from the archive (not on mag tapes!)
  -d, --diff, --compare      find differences between archive and file system
  -r, --append               append files to the end of an archive
      --test-label           test the archive volume label and exit
  -t, --list                 list the contents of an archive
  -u, --update               only append files newer than copy in archive
  -x, --extract, --get       extract files from an archive

 Operation modifiers:

      --check-device         check device numbers when creating incremental
                             archives (default)
  -g, --listed-incremental=FILE   handle new GNU-format incremental backup
  -G, --incremental          handle old GNU-format incremental backup
      --hole-detection=TYPE  technique to detect holes
      --ignore-failed-read   do not exit with nonzero on unreadable files
      --level=NUMBER         dump level for created listed-incremental archive
      --no-check-device      do not check device numbers when creating
                             incremental archives
      --no-seek              archive is not seekable
  -n, --seek                 archive is seekable
      --occurrence[=NUMBER]  process only the NUMBERth occurrence of each file
                             in the archive; this option is valid only in
                             conjunction with one of the subcommands --delete,
                             --diff, --extract or --list and when a list of
                             files is given either on the command line or via
                             the -T option; NUMBER defaults to 1
      --sparse-version=MAJOR[.MINOR]
                             set version of the sparse format to use (implies
                             --sparse)
  -S, --sparse               handle sparse files efficiently

 Local file name selection:
      --add-file=FILE        add given FILE to the archive (useful if its name
                             starts with a dash)
  -C, --directory=DIR        change to directory DIR
      --exclude=PATTERN      exclude files, given as a PATTERN
      --exclude-backups      exclude backup and lock files
      --exclude-caches       exclude contents of directories containing
                             CACHEDIR.TAG, except for the tag file itself
      --exclude-caches-all   exclude directories containing CACHEDIR.TAG
      --exclude-caches-under exclude everything under directories containing
                             CACHEDIR.TAG
      --exclude-ignore=FILE  read exclude patterns for each directory from
                             FILE, if it exists
      --exclude-ignore-recursive=FILE
                             read exclude patterns for each directory and its
                             subdirectories from FILE, if it exists
      --exclude-tag=FILE     exclude contents of directories containing FILE,
                             except for FILE itself
      --exclude-tag-all=FILE exclude directories containing FILE
      --exclude-tag-under=FILE   exclude everything under directories
                             containing FILE
      --exclude-vcs          exclude version control system directories
      --exclude-vcs-ignores  read exclude patterns from the VCS ignore files
      --no-null              disable the effect of the previous --null option
      --no-recursion         avoid descending automatically in directories
      --no-unquote           do not unquote input file or member names
      --no-verbatim-files-from   -T treats file names starting with dash as
                             options (default)
      --null                 -T reads null-terminated names; implies
                             --verbatim-files-from
      --recursion            recurse into directories (default)
  -T, --files-from=FILE      get names to extract or create from FILE
      --unquote              unquote input file or member names (default)
      --verbatim-files-from  -T reads file names verbatim (no escape or option
                             handling)
  -X, --exclude-from=FILE    exclude patterns listed in FILE

 File name matching options (affect both exclude and include patterns):

      --anchored             patterns match file name start
      --ignore-case          ignore case
      --no-anchored          patterns match after any '/' (default for
                             exclusion)
      --no-ignore-case       case sensitive matching (default)
      --no-wildcards         verbatim string matching
      --no-wildcards-match-slash   wildcards do not match '/'
      --wildcards            use wildcards (default for exclusion)
      --wildcards-match-slash   wildcards match '/' (default for exclusion)

 Overwrite control:

      --keep-directory-symlink   preserve existing symlinks to directories when
                             extracting
      --keep-newer-files     don't replace existing files that are newer than
                             their archive copies
  -k, --keep-old-files       don't replace existing files when extracting,
                             treat them as errors
      --no-overwrite-dir     preserve metadata of existing directories
      --one-top-level[=DIR]  create a subdirectory to avoid having loose files
                             extracted
      --overwrite            overwrite existing files when extracting
      --overwrite-dir        overwrite metadata of existing directories when
                             extracting (default)
      --recursive-unlink     empty hierarchies prior to extracting directory
      --remove-files         remove files after adding them to the archive
      --skip-old-files       don't replace existing files when extracting,
                             silently skip over them
  -U, --unlink-first         remove each file prior to extracting over it
  -W, --verify               attempt to verify the archive after writing it

 Select output stream:

      --ignore-command-error ignore exit codes of children
      --no-ignore-command-error   treat non-zero exit codes of children as
                             error
  -O, --to-stdout            extract files to standard output
      --to-command=COMMAND   pipe extracted files to another program

 Handling of file attributes:

      --atime-preserve[=METHOD]   preserve access times on dumped files, either
                             by restoring the times after reading
                             (METHOD='replace'; default) or by not setting the
                             times in the first place (METHOD='system')
      --clamp-mtime          only set time when the file is more recent than
                             what was given with --mtime
      --delay-directory-restore   delay setting modification times and
                             permissions of extracted directories until the end
                             of extraction
      --group=NAME           force NAME as group for added files
      --group-map=FILE       use FILE to map file owner GIDs and names
      --mode=CHANGES         force (symbolic) mode CHANGES for added files
      --mtime=DATE-OR-FILE   set mtime for added files from DATE-OR-FILE
  -m, --touch                don't extract file modified time
      --no-delay-directory-restore
                             cancel the effect of --delay-directory-restore
                             option
      --no-same-owner        extract files as yourself (default for ordinary
                             users)
      --no-same-permissions  apply the user's umask when extracting permissions
                             from the archive (default for ordinary users)
      --numeric-owner        always use numbers for user/group names
      --owner=NAME           force NAME as owner for added files
      --owner-map=FILE       use FILE to map file owner UIDs and names
  -p, --preserve-permissions, --same-permissions
                             extract information about file permissions
                             (default for superuser)
      --same-owner           try extracting files with the same ownership as
                             exists in the archive (default for superuser)
      --set-mtime-command=COMMAND
                             use output of the COMMAND to set mtime of the
                             stored archive members
      --set-mtime-format=FORMAT   set output format (in the sense of
                             strptime(3)) of the --set-mtime-command command
      --sort=ORDER           directory sorting order: none (default), name or
                             inode
  -s, --preserve-order, --same-order
                             member arguments are listed in the same order as
                             the files in the archive

 Handling of extended file attributes:

      --acls                 Enable the POSIX ACLs support
      --no-acls              Disable the POSIX ACLs support
      --no-selinux           Disable the SELinux context support
      --no-xattrs            Disable extended attributes support
      --selinux              Enable the SELinux context support
      --xattrs               Enable extended attributes support
      --xattrs-exclude=MASK  specify the exclude pattern for xattr keys
      --xattrs-include=MASK  specify the include pattern for xattr keys

 Device selection and switching:

      --force-local          archive file is local even if it has a colon
  -f, --file=ARCHIVE         use archive file or device ARCHIVE
  -F, --info-script=NAME, --new-volume-script=NAME
                             run script at end of each tape (implies -M)
  -L, --tape-length=NUMBER   change tape after writing NUMBER x 1024 bytes
  -M, --multi-volume         create/list/extract multi-volume archive
      --rmt-command=COMMAND  use given rmt COMMAND instead of rmt
      --rsh-command=COMMAND  use remote COMMAND instead of rsh
      --volno-file=FILE      use/update the volume number in FILE

 Device blocking:

  -b, --blocking-factor=BLOCKS   BLOCKS x 512 bytes per record
  -B, --read-full-records    reblock as we read (for 4.2BSD pipes)
  -i, --ignore-zeros         ignore zeroed blocks in archive (means EOF)
      --record-size=NUMBER   NUMBER of bytes per record, multiple of 512

 Archive format selection:

  -H, --format=FORMAT        create archive of the given format

 FORMAT is one of the following:
    gnu                      GNU tar 1.13.x format
    oldgnu                   GNU format as per tar <= 1.12
    pax                      POSIX 1003.1-2001 (pax) format
    posix                    same as pax
    ustar                    POSIX 1003.1-1988 (ustar) format
    v7                       old V7 tar format

      --old-archive, --portability
                             same as --format=v7
      --pax-option=keyword[[:]=value][,keyword[[:]=value]]...
                             control pax keywords
      --posix                same as --format=posix
  -V, --label=TEXT           create archive with volume name TEXT; at
                             list/extract time, use TEXT as a globbing pattern
                             for volume name

 Compression options:

  -a, --auto-compress        use archive suffix to determine the compression
                             program
  -I, --use-compress-program=PROG
                             filter through PROG (must accept -d)
  -j, --bzip2                filter the archive through bzip2
  -J, --xz                   filter the archive through xz
      --lzip                 filter the archive through lzip
      --lzma                 filter the archive through lzma
      --lzop                 filter the archive through lzop
      --no-auto-compress     do not use archive suffix to determine the
                             compression program
      --zstd                 filter the archive through zstd
  -z, --gzip, --gunzip, --ungzip   filter the archive through gzip
  -Z, --compress, --uncompress   filter the archive through compress

 Local file selection:

      --backup[=CONTROL]     backup before removal, choose version CONTROL
      --hard-dereference     follow hard links; archive and dump the files they
                             refer to
  -h, --dereference          follow symlinks; archive and dump the files they
                             point to
  -K, --starting-file=MEMBER-NAME
                             begin at member MEMBER-NAME when reading the
                             archive
      --newer-mtime=DATE     compare date and time when data changed only
  -N, --newer=DATE-OR-FILE, --after-date=DATE-OR-FILE
                             only store files newer than DATE-OR-FILE
      --one-file-system      stay in local file system when creating archive
  -P, --absolute-names       don't strip leading '/'s from file names
      --suffix=STRING        backup before removal, override usual suffix ('~'
                             unless overridden by environment variable
                             SIMPLE_BACKUP_SUFFIX)

 File name transformations:

      --strip-components=NUMBER   strip NUMBER leading components from file
                             names on extraction
      --transform=EXPRESSION, --xform=EXPRESSION
                             use sed replace EXPRESSION to transform file
                             names

 Informative output:

      --checkpoint[=NUMBER]  display progress messages every NUMBERth record
                             (default 10)
      --checkpoint-action=ACTION   execute ACTION on each checkpoint
      --full-time            print file time to its full resolution
      --index-file=FILE      send verbose output to FILE
  -l, --check-links          print a message if not all links are dumped
      --no-quote-chars=STRING   disable quoting for characters from STRING
      --quote-chars=STRING   additionally quote characters from STRING
      --quoting-style=STYLE  set name quoting style; see below for valid STYLE
                             values
  -R, --block-number         show block number within archive with each message

      --show-defaults        show tar defaults
      --show-omitted-dirs    when listing or extracting, list each directory
                             that does not match search criteria
      --show-snapshot-field-ranges
                             show valid ranges for snapshot-file fields
      --show-transformed-names, --show-stored-names
                             show file or archive names after transformation
      --totals[=SIGNAL]      print total bytes after processing the archive;
                             with an argument - print total bytes when this
                             SIGNAL is delivered; Allowed signals are: SIGHUP,
                             SIGQUIT, SIGINT, SIGUSR1 and SIGUSR2; the names
                             without SIG prefix are also accepted
      --utc                  print file modification times in UTC
  -v, --verbose              verbosely list files processed
      --warning=KEYWORD      warning control
  -w, --interactive, --confirmation
                             ask for confirmation for every action

 Compatibility options:

  -o                         when creating, same as --old-archive; when
                             extracting, same as --no-same-owner

 Other options:

  -?, --help                 give this help list
      --restrict             disable use of some potentially harmful options
      --usage                give a short usage message
      --version              print program version

Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.

The backup suffix is '~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.
The version control may be set with --backup or VERSION_CONTROL, values are:

  none, off       never make backups
  t, numbered     make numbered backups
  nil, existing   numbered if numbered backups exist, simple otherwise
  never, simple   always make simple backups

Valid arguments for the --quoting-style option are:

  literal
  shell
  shell-always
  shell-escape
  shell-escape-always
  c
  c-maybe
  escape
  locale
  clocale

*This* tar defaults to:
--format=gnu -f- -b20 --quoting-style=escape --rmt-command=/usr/libexec/rmt
Options (159)
OptionDescriptionSource
-A, --catenate, --concatenateappend tar files to an archivehelp
-c, --createcreate a new archivehelp
--deletedelete from the archive (not on mag tapes!)help
-d, --diff, --comparefind differences between archive and file systemhelp
-r, --appendappend files to the end of an archivehelp
--test-labeltest the archive volume label and exithelp
-t, --listlist the contents of an archivehelp
-u, --updateonly append files newer than copy in archivehelp
-x, --extract, --getextract files from an archivehelp
--check-deviceCheck device numbers when creating incremental archives (default).help + man
-g, --listed-incremental FILEHandle new GNU-format incremental backups.help + man
-G, --incrementalHandle old GNU-format incremental backups.help + man
--hole-detection TYPEUse METHOD to detect holes in sparse files.help + man
--ignore-failed-readDo not exit with nonzero on unreadable files.help + man
--level NUMBERSet dump level for a created listed-incremental archive.help + man
--no-check-deviceDo not check device numbers when creating incremental archives.help + man
--no-seekAssume the archive is not seekable.help + man
-n, --seekAssume the archive is seekable.help + man
--occurrence NUMBERprocess only the NUMBERth occurrence of each file in the archive;help
--sparse-version MAJOR[.MINORset version of the sparse format to use (implieshelp
-S, --sparseHandle sparse files efficiently.help + man
--add-file FILEadd given FILE to the archive (useful if its name starts with a dash)help + man
-C, --directory DIRChange to DIR before performing any operations.help + man
--exclude PATTERNExclude files matching PATTERN, a glob(3)-style wildcard pattern.help + man
--exclude-backupsExclude backup and lock files.help + man
--exclude-cachesExclude contents of directories containing file CACHEDIR.TAG, except for the tag file itself.help + man
--exclude-caches-allExclude directories containing file CACHEDIR.TAG and the file itself.help + man
--exclude-ignore FILEread exclude patterns for each directory from FILE, if it existshelp + man
--exclude-ignore-recursive FILESame as --exclude-ignore, except that patterns from FILE affect both the directory and all its subdirectories.help + man
--exclude-tag FILEExclude contents of directories containing FILE, except for FILE itself.help + man
--exclude-tag-under FILEExclude everything under directories containing FILE.help + man
--exclude-vcsExclude version control system directories.help + man
--exclude-vcs-ignoresExclude files that match patterns read from VCS-specific ignore files.help + man
--no-nullDisable the effect of the previous --null option.help + man
--no-recursionAvoid descending automatically in directories.help + man
--no-unquoteDo not unquote input file or member names.help + man
--no-verbatim-files-fromTreat each line read from a file list as if it were supplied in the command line.help + man
--nullInstruct subsequent -T options to read null-terminated names verbatim (disables special handling of names that start with a dash).help + man
--recursionRecurse into directories (default).help + man
-T, --files-from FILEGet names to extract or create from FILE.help + man
--unquoteunquote input file or member names (default)help + man
--verbatim-files-fromTreat each line obtained from a file list as a file name, even if it starts with a dash.help + man
-X, --exclude-from FILEExclude files matching patterns listed in FILE.help + man
--anchoredPatterns match file name start.help + man
--ignore-caseIgnore case.help + man
--no-anchoredpatterns match after any '/' (default for exclusion)help + man
--no-ignore-caseCase sensitive matching (default).help + man
--no-wildcardsVerbatim string matching.help + man
--no-wildcards-match-slashwildcards do not match '/'help + man
--wildcardsUse wildcards (default for exclusion).help + man
--wildcards-match-slashwildcards match '/' (default for exclusion)help + man
--keep-directory-symlinkDon't replace existing symlinks to directories when extracting.help + man
--keep-newer-filesDon't replace existing files that are newer than their archive copies.help + man
-k, --keep-old-filesdon't replace existing files when extracting, treat them as errorshelp + man
--no-overwrite-dirPreserve metadata of existing directories.help + man
--one-top-level DIRcreate a subdirectory to avoid having loose files extractedhelp
--overwriteOverwrite existing files when extracting.help + man
--overwrite-dirOverwrite metadata of existing directories when extracting (default).help + man
--recursive-unlinkRecursively remove all files in the directory prior to extracting it.help + man
--remove-filesRemove files from disk after adding them to the archive.help + man
--skip-old-filesDon't replace existing files when extracting, silently skip over them.help + man
-U, --unlink-firstRemove each file prior to extracting over it.help + man
-W, --verifyattempt to verify the archive after writing ithelp + man
--no-ignore-command-errorTreat non-zero exit codes of children as error (default).help + man
-O, --to-stdoutExtract files to standard output.help + man
--to-command COMMANDpipe extracted files to another programhelp + man
--atime-preserve METHODpreserve access times on dumped files, either by restoring the times after reading (METHOD='replace';help
--clamp-mtimeOnly set time when the file is more recent than what was given with --mtime.help + man
--delay-directory-restoreDelay setting modification times and permissions of extracted directories until the end of extraction.help + man
--group NAMEforce NAME as group for added fileshelp
--group-map FILEuse FILE to map file owner GIDs and nameshelp + man
--mode CHANGESforce (symbolic) mode CHANGES for added fileshelp + man
--mtime DATE-OR-FILEset mtime for added files from DATE-OR-FILEhelp + man
-m, --touchDon't extract file modified time.help + man
--no-delay-directory-restoreCancel the effect of the prior --delay-directory-restore option.help + man
--no-same-ownerExtract files as yourself (default for ordinary users).help + man
--no-same-permissionsApply the user's umask when extracting permissions from the archive (default for ordinary users).help + man
--numeric-ownerAlways use numbers for user/group names.help + man
--owner NAMEforce NAME as owner for added fileshelp
--owner-map FILEuse FILE to map file owner UIDs and nameshelp + man
-p, --preserve-permissions, --same-permissionsSet permissions of extracted files to those recorded in the archive (default for superuser).help + man
--same-ownerTry extracting files with the same ownership as exists in the archive (default for superuser).help + man
--set-mtime-command COMMANDuse output of the COMMAND to set mtime of the stored archive membershelp
--set-mtime-format FORMATset output format (in the sense of strptime(3)) of the --set-mtime-command commandhelp
--sort ORDERWhen creating an archive, sort directory entries according to ORDER, which is one of none, name, or inode.help + man
-s, --preserve-order, --same-orderTell tar that the list of file names to process is sorted in the same order as the files in the archive.help + man
--aclsEnable the POSIX ACLs supporthelp + man
--no-aclsDisable the POSIX ACLs supporthelp + man
--no-selinuxDisable the SELinux context supporthelp + man
--no-xattrsDisable extended attributes support.help + man
--selinuxEnable the SELinux context supporthelp + man
--xattrsEnable extended attributes support.help + man
--xattrs-exclude MASKSpecify the exclude pattern for xattr keys.help + man
--xattrs-include MASKSpecify the include pattern for xattr keys.help + man
--force-localArchive file is local even if it has a colon.help + man
-f, --file ARCHIVEUse archive file or device ARCHIVE.help + man
-F, --info-script, --new-volume-script NAMERun COMMAND at the end of each tape (implies -M).help + man
-L, --tape-length NUMBERchange tape after writing NUMBER x 1024 byteshelp + man
-M, --multi-volumeCreate/list/extract multi-volume archive.help + man
--rmt-command COMMANDUse COMMAND instead of rmt when accessing remote archives.help + man
--rsh-command COMMANDUse COMMAND instead of rsh when accessing remote archives.help + man
--volno-file FILEWhen this option is used in conjunction with --multi-volume, tar will keep track of which volume of a multi-volume archive it is working in FILE.help + man
-b, --blocking-factor BLOCKSSet record size to BLOCKSx512 bytes.help + man
-B, --read-full-recordsWhen listing or extracting, accept incomplete input records after end-of-file marker.help + man
-i, --ignore-zerosignore zeroed blocks in archive (means EOF)help + man
--record-size NUMBERNUMBER of bytes per record, multiple of 512help + man
-H, --format FORMATCreate archive of the given format.help + man
--old-archive, --portabilitySame as --format=v7.help + man
--pax-option keyword[[:]=valuecontrol pax keywordshelp
--posixSame as --format=posix.help + man
-V, --label TEXTcreate archive with volume name TEXT;help + man
-a, --auto-compressUse archive suffix to determine the compression program.help + man
-I, --use-compress-program PROGfilter through PROG (must accept -d)help + man
-j, --bzip2Filter the archive through bzip2(1).help + man
-J, --xzFilter the archive through xz(1).help + man
--lzipFilter the archive through lzip(1).help + man
--lzmaFilter the archive through lzma(1).help + man
--lzopFilter the archive through lzop(1).help + man
--no-auto-compressDo not use archive suffix to determine the compression program.help + man
--zstdFilter the archive through zstd(1).help + man
-z, --gzip, --gunzip, --ungzipFilter the archive through gzip(1).help + man
-Z, --compress, --uncompressFilter the archive through compress(1).help + man
--backup CONTROLbackup before removal, choose version CONTROLhelp
--hard-dereferencefollow hard links;help + man
-h, --dereferencefollow symlinks;help + man
-K, --starting-file MEMBER-NAMEbegin at member MEMBER-NAME when reading the archivehelp + man
--newer-mtime DATEWork on files whose data changed after the DATE.help + man
-N, --newer, --after-date DATE-OR-FILEonly store files newer than DATE-OR-FILEhelp + man
--one-file-systemStay in local file system when creating archive.help + man
-P, --absolute-namesDon't strip leading slashes from file names when creating archives.help + man
--suffix STRINGbackup before removal, override usual suffix ('~' unless overridden by environment variable SIMPLE_BACKUP_SUFFIX)help + man
--strip-components NUMBERStrip NUMBER leading components from file names on extraction.help + man
--transform, --xform EXPRESSIONUse sed replace EXPRESSION to transform file names.help + man
--checkpoint NUMBERdisplay progress messages every NUMBERth record (default 10)help
--checkpoint-action ACTIONexecute ACTION on each checkpointhelp + man
--full-timePrint file time to its full resolution.help + man
--index-file FILESend verbose output to FILE.help + man
-l, --check-linksPrint a message if not all links are dumped.help + man
--no-quote-chars STRINGDisable quoting for characters from STRING.help + man
--quote-chars STRINGAdditionally quote characters from STRING.help + man
--quoting-style STYLESet quoting style for file and member names.help + man
-R, --block-numberShow block number within archive with each message.help + man
--show-defaultsshow tar defaultshelp
--show-omitted-dirsWhen listing or extracting, list each directory that does not match search criteria.help + man
--show-snapshot-field-rangesshow valid ranges for snapshot-file fieldshelp
--show-transformed-names, --show-stored-namesShow file or archive names after transformation by --strip and --transform options.help + man
--totals SIGNALprint total bytes after processing the archive;help
--utcPrint file modification times in UTC.help + man
-v, --verboseVerbosely list files processed.help + man
--warning KEYWORDEnable or disable warning messages identified by KEYWORD.help + man
-w, --interactive, --confirmationAsk for confirmation for every action.help + man
-owhen creating, same as --old-archive;help + man
-?, --helpgive this help listhelp
--restrictDisable the use of some potentially harmful options.help + man
--usagegive a short usage messagehelp
--versionprint program versionhelp
--ignore-command-errorIgnore subprocess exit codes. (in the manual page but not in --help)man
--exclude-caches-underExclude everything under directories containing CACHEDIR.TAG (in the manual page but not in --help)man
--exclude-tag-all FILEExclude directories containing FILE. (in the manual page but not in --help)man
Exit status (3) from the manual page
0Successful termination.
1Some files differ.
2Fatal error.

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.