{ "content": [ { "type": "text", "text": "# tar (man)\n\n## NAME\n\ntar - an archiving utility\n\n## DESCRIPTION\n\nGNU tar is an archiving program designed to store multiple files in a single file (an\narchive), and to manipulate such archives. The archive can be either a regular file or a de‐\nvice (e.g. a tape drive, hence the name of the program, which stands for tape archiver),\nwhich can be located either on the local or on a remote machine.\n\n## TLDR\n\n> Archiving utility.\n\n- [c]reate an archive and write it to a [f]ile:\n `tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}`\n- [c]reate a g[z]ipped archive and write it to a [f]ile:\n `tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}`\n- [c]reate a g[z]ipped (compressed) archive from a directory using relative paths:\n `tar czf {{path/to/target.tar.gz}} {{-C|--directory}} {{path/to/directory}} .`\n- E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:\n `tar xvf {{path/to/source.tar[.gz|.bz2|.xz}}`\n- E[x]tract a (compressed) archive [f]ile into the target directory:\n `tar xf {{path/to/source.tar[.gz|.bz2|.xz}} {{-C|--directory}} {{path/to/directory}}`\n- [c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program:\n `tar caf {{path/to/target.tar.xz}} {{path/to/file1 path/to/file2 ...}}`\n- Lis[t] the contents of a tar [f]ile [v]erbosely:\n `tar tvf {{path/to/source.tar}}`\n- E[x]tract files matching a pattern from an archive [f]ile:\n `tar xf {{path/to/source.tar}} --wildcards \"{{*.html}}\"`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS** (3 subsections)\n- **NOTE**\n- **DESCRIPTION** (14 subsections)\n- **OPTIONS** (108 subsections)\n- **RETURN VALUE**\n- **SEE ALSO**\n- **BUG REPORTS**\n- **COPYRIGHT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "tar", "section": "", "mode": "man", "summary": "tar - an archiving utility", "synopsis": "", "tldr_summary": "Archiving utility.", "tldr_examples": [ { "description": "[c]reate an archive and write it to a [f]ile", "command": "tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}" }, { "description": "[c]reate a g[z]ipped archive and write it to a [f]ile", "command": "tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}" }, { "description": "[c]reate a g[z]ipped (compressed) archive from a directory using relative paths", "command": "tar czf {{path/to/target.tar.gz}} {{-C|--directory}} {{path/to/directory}} ." }, { "description": "E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely", "command": "tar xvf {{path/to/source.tar[.gz|.bz2|.xz}}" }, { "description": "E[x]tract a (compressed) archive [f]ile into the target directory", "command": "tar xf {{path/to/source.tar[.gz|.bz2|.xz}} {{-C|--directory}} {{path/to/directory}}" }, { "description": "[c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program", "command": "tar caf {{path/to/target.tar.xz}} {{path/to/file1 path/to/file2 ...}}" }, { "description": "Lis[t] the contents of a tar [f]ile [v]erbosely", "command": "tar tvf {{path/to/source.tar}}" }, { "description": "E[x]tract files matching a pattern from an archive [f]ile", "command": "tar xf {{path/to/source.tar}} --wildcards \"{{*.html}}\"" } ], "tldr_source": "official", "flags": [ { "flag": "", "long": "--check-device", "arg": null, "description": "Check device numbers when creating incremental archives (default)." }, { "flag": "-g", "long": "--listed-incremental", "arg": null, "description": "Handle new GNU-format incremental backups. FILE is the name of a snapshot file, where tar stores additional information which is used to decide which files changed since the previous incremental dump and, consequently, must be dumped again. If FILE does not exist when creating an archive, it will be created and all files will be added to the resulting archive (the level 0 dump). To create incremental archives of non-zero level N, you need a copy of the snapshot file created for level N-1, and use it as FILE. When listing or extracting, the actual content of FILE is not inspected, it is needed only due to syntactical requirements. It is therefore common practice to use /dev/null in its place. --hole-detection=METHOD Use METHOD to detect holes in sparse files. This option implies --sparse. Valid val‐ ues for METHOD are seek and raw. Default is seek with fallback to raw when not ap‐ plicable." }, { "flag": "-G", "long": "--incremental", "arg": null, "description": "Handle old GNU-format incremental backups." }, { "flag": "", "long": "--ignore-failed-read", "arg": null, "description": "Do not exit with nonzero on unreadable files. --level=NUMBER Set dump level for a created listed-incremental archive. Currently only --level=0 is meaningful: it instructs tar to truncate the snapshot file before dumping, thereby forcing a level 0 dump." }, { "flag": "-n", "long": "--seek", "arg": null, "description": "Assume the archive is seekable. Normally tar determines automatically whether the archive can be seeked or not. This option is intended for use in cases when such recognition fails. It takes effect only if the archive is open for reading (e.g. with --list or --extract options)." }, { "flag": "", "long": "--no-check-device", "arg": null, "description": "Do not check device numbers when creating incremental archives." }, { "flag": "", "long": "--no-seek", "arg": null, "description": "Assume the archive is not seekable. --occurrence[=N] Process only the Nth occurrence of each file in the archive. This option is valid only when used with one of the following subcommands: --delete, --diff, --extract or --list and when a list of files is given either on the command line or via the -T op‐ tion. The default N is 1." }, { "flag": "", "long": "--restrict", "arg": null, "description": "Disable the use of some potentially harmful options. --sparse-version=MAJOR[.MINOR] Set which version of the sparse format to use. This option implies --sparse. Valid argument values are 0.0, 0.1, and 1.0. For a detailed discussion of sparse formats, refer to the GNU Tar Manual, appendix D, \"Sparse Formats\". Using the info reader, it can be accessed running the following command: info tar 'Sparse Formats'." }, { "flag": "-S", "long": "--sparse", "arg": null, "description": "Handle sparse files efficiently. Some files in the file system may have segments which were actually never written (quite often these are database files created by such systems as DBM). When given this option, tar attempts to determine if the file is sparse prior to archiving it, and if so, to reduce the resulting archive size by not dumping empty parts of the file." }, { "flag": "-k", "long": "--keep-old-files", "arg": null, "description": "Don't replace existing files when extracting." }, { "flag": "", "long": "--keep-newer-files", "arg": null, "description": "Don't replace existing files that are newer than their archive copies." }, { "flag": "", "long": "--keep-directory-symlink", "arg": null, "description": "Don't replace existing symlinks to directories when extracting." }, { "flag": "", "long": "--no-overwrite-dir", "arg": null, "description": "Preserve metadata of existing directories. --one-top-level[=DIR] Extract all files into DIR, or, if used without argument, into a subdirectory named by the base name of the archive (minus standard compression suffixes recognizable by --auto-compress)." }, { "flag": "", "long": "--overwrite", "arg": null, "description": "Overwrite existing files when extracting." }, { "flag": "", "long": "--overwrite-dir", "arg": null, "description": "Overwrite metadata of existing directories when extracting (default)." }, { "flag": "", "long": "--recursive-unlink", "arg": null, "description": "Recursively remove all files in the directory prior to extracting it." }, { "flag": "", "long": "--remove-files", "arg": null, "description": "Remove files from disk after adding them to the archive." }, { "flag": "", "long": "--skip-old-files", "arg": null, "description": "Don't replace existing files when extracting, silently skip over them." }, { "flag": "-U", "long": "--unlink-first", "arg": null, "description": "Remove each file prior to extracting over it." }, { "flag": "-W", "long": "--verify", "arg": null, "description": "Verify the archive after writing it." }, { "flag": "", "long": "--ignore-command-error", "arg": null, "description": "Ignore subprocess exit codes." }, { "flag": "", "long": "--no-ignore-command-error", "arg": null, "description": "Treat non-zero exit codes of children as error (default)." }, { "flag": "-O", "long": "--to-stdout", "arg": null, "description": "Extract files to standard output. --to-command=COMMAND Pipe extracted files to COMMAND. The argument is the pathname of an external program, optionally with command line arguments. The program will be invoked and the contents of the file being extracted supplied to it on its standard input. Additional data will be supplied via the following environment variables: TARFILETYPE Type of the file. It is a single letter with the following meaning: f Regular file d Directory l Symbolic link h Hard link b Block device c Character device Currently only regular files are supported. TARMODE File mode, an octal number. TARFILENAME The name of the file. TARREALNAME Name of the file as stored in the archive. TARUNAME Name of the file owner. TARGNAME Name of the file owner group. TARATIME Time of last access. It is a decimal number, representing seconds since the Epoch. If the archive provides times with nanosecond precision, the nanosec‐ onds are appended to the timestamp after a decimal point. TARMTIME Time of last modification. TARCTIME Time of last status change. TARSIZE Size of the file. TARUID UID of the file owner. TARGID GID of the file owner. Additionally, the following variables contain information about tar operation mode and the archive being processed: TARVERSION GNU tar version number. TARARCHIVE The name of the archive tar is processing. TARBLOCKINGFACTOR Current blocking factor, i.e. number of 512-byte blocks in a record. TARVOLUME Ordinal number of the volume tar is processing (set if reading a multi-volume archive). TARFORMAT Format of the archive being processed. One of: gnu, oldgnu, posix, ustar, v7. TARSUBCOMMAND A short option (with a leading dash) describing the operation tar is executing." }, { "flag": "", "long": "--delay-directory-restore", "arg": null, "description": "Delay setting modification times and permissions of extracted directories until the end of extraction. Use this option when extracting from an archive which has unusual member ordering. --group=NAME[:GID] Force NAME as group for added files. If GID is not supplied, NAME can be either a user name or numeric GID. In this case the missing part (GID or name) will be in‐ ferred from the current host's group database. When used with --group-map=FILE, affects only those files whose owner group is not listed in FILE. --group-map=FILE Read group translation map from FILE. Empty lines are ignored. Comments are intro‐ duced with # sign and extend to the end of line. Each non-empty line in FILE defines translation for a single group. It must consist of two fields, delimited by any amount of whitespace: OLDGRP NEWGRP[:NEWGID] OLDGRP is either a valid group name or a GID prefixed with +. Unless NEWGID is sup‐ plied, NEWGRP must also be either a valid group name or a +GID. Otherwise, both NEW‐ GRP and NEWGID need not be listed in the system group database. As a result, each input file with owner group OLDGRP will be stored in archive with owner group NEWGRP and GID NEWGID. --mode=CHANGES Force symbolic mode CHANGES for added files. --mtime=DATE-OR-FILE Set mtime for added files. DATE-OR-FILE is either a date/time in almost arbitrary format, or the name of an existing file. In the latter case the mtime of that file will be used." }, { "flag": "-m", "long": "--touch", "arg": null, "description": "Don't extract file modified time." }, { "flag": "", "long": "--no-delay-directory-restore", "arg": null, "description": "Cancel the effect of the prior --delay-directory-restore option." }, { "flag": "", "long": "--no-same-owner", "arg": null, "description": "Extract files as yourself (default for ordinary users)." }, { "flag": "", "long": "--no-same-permissions", "arg": null, "description": "Apply the user's umask when extracting permissions from the archive (default for ordi‐ nary users)." }, { "flag": "", "long": "--numeric-owner", "arg": null, "description": "Always use numbers for user/group names. --owner=NAME[:UID] Force NAME as owner for added files. If UID is not supplied, NAME can be either a user name or numeric UID. In this case the missing part (UID or name) will be in‐ ferred from the current host's user database. When used with --owner-map=FILE, affects only those files whose owner is not listed in FILE. --owner-map=FILE Read owner translation map from FILE. Empty lines are ignored. Comments are intro‐ duced with # sign and extend to the end of line. Each non-empty line in FILE defines translation for a single UID. It must consist of two fields, delimited by any amount of whitespace: OLDUSR NEWUSR[:NEWUID] OLDUSR is either a valid user name or a UID prefixed with +. Unless NEWUID is sup‐ plied, NEWUSR must also be either a valid user name or a +UID. Otherwise, both NEWUSR and NEWUID need not be listed in the system user database. As a result, each input file owned by OLDUSR will be stored in archive with owner name NEWUSR and UID NEWUID." }, { "flag": "-p", "long": "--same-permissions", "arg": null, "description": "Set permissions of extracted files to those recorded in the archive (default for supe‐ ruser)." }, { "flag": "", "long": "--same-owner", "arg": null, "description": "Try extracting files with the same ownership as exists in the archive (default for su‐ peruser)." }, { "flag": "-s", "long": "--same-order", "arg": null, "description": "Tell tar that the list of file names to process is sorted in the same order as the files in the archive. --sort=ORDER When creating an archive, sort directory entries according to ORDER, which is one of none, name, or inode. The default is --sort=none, which stores archive members in the same order as returned by the operating system. Using --sort=name ensures the member ordering in the created archive is uniform and reproducible. Using --sort=inode reduces the number of disk seeks made when creating the archive and thus can considerably speed up archivation. This sorting order is supported only if the underlying system provides the necessary information." }, { "flag": "", "long": "--no-acls", "arg": null, "description": "Disable POSIX ACLs support." }, { "flag": "", "long": "--selinux", "arg": null, "description": "Enable SELinux context support." }, { "flag": "", "long": "--no-selinux", "arg": null, "description": "Disable SELinux context support." }, { "flag": "", "long": "--xattrs", "arg": null, "description": "Enable extended attributes support." }, { "flag": "", "long": "--no-xattrs", "arg": null, "description": "Disable extended attributes support. --xattrs-exclude=PATTERN Specify the exclude pattern for xattr keys. PATTERN is a globbing pattern, e.g. --xattrs-exclude='user.*' to include only attributes from the user namespace. --xattrs-include=PATTERN Specify the include pattern for xattr keys. PATTERN is a globbing pattern." }, { "flag": "-f", "long": "--file", "arg": null, "description": "Use archive file or device ARCHIVE. If this option is not given, tar will first exam‐ ine the environment variable `TAPE'. If it is set, its value will be used as the archive name. Otherwise, tar will assume the compiled-in default. The default value can be inspected either using the --show-defaults option, or at the end of the tar --help output. An archive name that has a colon in it specifies a file or device on a remote machine. The part before the colon is taken as the machine name or IP address, and the part af‐ ter it as the file or device pathname, e.g.: --file=remotehost:/dev/sr0 An optional username can be prefixed to the hostname, placing a @ sign between them. By default, the remote host is accessed via the rsh(1) command. Nowadays it is common to use ssh(1) instead. You can do so by giving the following command line option: --rsh-command=/usr/bin/ssh The remote machine should have the rmt(8) command installed. If its pathname does not match tar's default, you can inform tar about the correct pathname using the --rmt-command option." }, { "flag": "", "long": "--force-local", "arg": null, "description": "Archive file is local even if it has a colon." }, { "flag": "-F", "long": "--new-volume-script", "arg": null, "description": "Run COMMAND at the end of each tape (implies -M). The command can include arguments. When started, it will inherit tar's environment plus the following variables: TARVERSION GNU tar version number. TARARCHIVE The name of the archive tar is processing. TARBLOCKINGFACTOR Current blocking factor, i.e. number of 512-byte blocks in a record. TARVOLUME Ordinal number of the volume tar is processing (set if reading a multi-volume archive). TARFORMAT Format of the archive being processed. One of: gnu, oldgnu, posix, ustar, v7. TARSUBCOMMAND A short option (with a leading dash) describing the operation tar is executing. TARFD File descriptor which can be used to communicate the new volume name to tar. If the info script fails, tar exits; otherwise, it begins writing the next volume." }, { "flag": "-L", "long": "--tape-length", "arg": null, "description": "Change tape after writing Nx1024 bytes. If N is followed by a size suffix (see the subsection Size suffixes below), the suffix specifies the multiplicative factor to be used instead of 1024. This option implies -M." }, { "flag": "-M", "long": "--multi-volume", "arg": null, "description": "Create/list/extract multi-volume archive. --rmt-command=COMMAND Use COMMAND instead of rmt when accessing remote archives. See the description of the -f option, above. --rsh-command=COMMAND Use COMMAND instead of rsh when accessing remote archives. See the description of the -f option, above. --volno-file=FILE When 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." }, { "flag": "-b", "long": "--blocking-factor", "arg": null, "description": "Set record size to BLOCKSx512 bytes." }, { "flag": "-B", "long": "--read-full-records", "arg": null, "description": "When listing or extracting, accept incomplete input records after end-of-file marker." }, { "flag": "-i", "long": "--ignore-zeros", "arg": null, "description": "Ignore zeroed blocks in archive. Normally two consecutive 512-blocks filled with ze‐ roes mean EOF and tar stops reading after encountering them. This option instructs it to read further and is useful when reading archives created with the -A option. --record-size=NUMBER Set record size. NUMBER is the number of bytes per record. It must be multiple of 512. It can can be suffixed with a size suffix, e.g. --record-size=10K, for 10 Kilo‐ bytes. See the subsection Size suffixes, for a list of valid suffixes." }, { "flag": "-H", "long": "--format", "arg": null, "description": "Create archive of the given format. Valid formats are: gnu GNU tar 1.13.x format oldgnu GNU format as per tar <= 1.12. pax, posix POSIX 1003.1-2001 (pax) format. 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 when creating PAX archives (-H pax). This option is equivalent to the -o option of the pax(1) utility." }, { "flag": "", "long": "--posix", "arg": null, "description": "Same as --format=posix." }, { "flag": "-V", "long": "--label", "arg": null, "description": "Create archive with volume name TEXT. If listing or extracting, use TEXT as a glob‐ bing pattern for volume name." }, { "flag": "-a", "long": "--auto-compress", "arg": null, "description": "Use archive suffix to determine the compression program." }, { "flag": "-I", "long": "--use-compress-program_", "arg": null, "description": "Filter data through COMMAND. It must accept the -d option, for decompression. The argument can contain command line options." }, { "flag": "-j", "long": "--bzip2", "arg": null, "description": "Filter the archive through bzip2(1)." }, { "flag": "-J", "long": "--xz", "arg": null, "description": "Filter the archive through xz(1). --lzip Filter the archive through lzip(1). --lzma Filter the archive through lzma(1). --lzop Filter the archive through lzop(1)." }, { "flag": "", "long": "--no-auto-compress", "arg": null, "description": "Do not use archive suffix to determine the compression program." }, { "flag": "-z", "long": "--ungzip", "arg": null, "description": "Filter the archive through gzip(1)." }, { "flag": "-Z", "long": "--uncompress", "arg": null, "description": "Filter the archive through compress(1). --zstd Filter the archive through zstd(1)." }, { "flag": "-C", "long": "--directory", "arg": null, "description": "Change to DIR before performing any operations. This option is order-sensitive, i.e. it affects all options that follow. --exclude=PATTERN Exclude files matching PATTERN, a glob(3)-style wildcard pattern." }, { "flag": "", "long": "--exclude-backups", "arg": null, "description": "Exclude backup and lock files." }, { "flag": "", "long": "--exclude-caches", "arg": null, "description": "Exclude contents of directories containing file CACHEDIR.TAG, except for the tag file itself." }, { "flag": "", "long": "--exclude-caches-all", "arg": null, "description": "Exclude directories containing file CACHEDIR.TAG and the file itself." }, { "flag": "", "long": "--exclude-caches-under", "arg": null, "description": "Exclude everything under directories containing CACHEDIR.TAG --exclude-ignore=FILE Before dumping a directory, see if it contains FILE. If so, read exclusion patterns from this file. The patterns affect only the directory itself. --exclude-ignore-recursive=FILE Same as --exclude-ignore, except that patterns from FILE affect both the directory and all its subdirectories. --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." }, { "flag": "", "long": "--exclude-vcs", "arg": null, "description": "Exclude version control system directories." }, { "flag": "", "long": "--exclude-vcs-ignores", "arg": null, "description": "Exclude files that match patterns read from VCS-specific ignore files. Supported files are: .cvsignore, .gitignore, .bzrignore, and .hgignore." }, { "flag": "-h", "long": "--dereference", "arg": null, "description": "Follow symlinks; archive and dump the files they point to." }, { "flag": "", "long": "--hard-dereference", "arg": null, "description": "Follow hard links; archive and dump the files they refer to." }, { "flag": "-K", "long": "--starting-file", "arg": null, "description": "Begin at the given member in the archive. --newer-mtime=DATE Work on files whose data changed after the DATE. If DATE starts with / or . it is taken to be a file name; the mtime of that file is used as the date." }, { "flag": "", "long": "--no-null", "arg": null, "description": "Disable the effect of the previous --null option." }, { "flag": "", "long": "--no-recursion", "arg": null, "description": "Avoid descending automatically in directories." }, { "flag": "", "long": "--no-unquote", "arg": null, "description": "Do not unquote input file or member names." }, { "flag": "", "long": "--no-verbatim-files-from", "arg": null, "description": "Treat each line read from a file list as if it were supplied in the command line. I.e., leading and trailing whitespace is removed and, if the resulting string begins with a dash, it is treated as tar command line option. This is the default behavior. The --no-verbatim-files-from option is provided as a way to restore it after --verbatim-files-from option. This option is positional: it affects all --files-from options that occur after it in, until --verbatim-files-from option or end of line, whichever occurs first. It is implied by the --no-null option. --null Instruct subsequent -T options to read null-terminated names verbatim (disables spe‐ cial handling of names that start with a dash). See also --verbatim-files-from." }, { "flag": "-N", "long": "--after-date", "arg": null, "description": "Only store files newer than DATE. If DATE starts with / or . it is taken to be a file name; the mtime of that file is used as the date." }, { "flag": "", "long": "--one-file-system", "arg": null, "description": "Stay in local file system when creating archive." }, { "flag": "-P", "long": "--absolute-names", "arg": null, "description": "Don't strip leading slashes from file names when creating archives." }, { "flag": "", "long": "--recursion", "arg": null, "description": "Recurse into directories (default). --suffix=STRING Backup before removal, override usual suffix. Default suffix is ~, unless overridden by environment variable SIMPLEBACKUPSUFFIX." }, { "flag": "-T", "long": "--files-from", "arg": null, "description": "Get names to extract or create from FILE. Unless specified otherwise, the FILE must contain a list of names separated by ASCII LF (i.e. one name per line). The names read are handled the same way as command line arguments. They undergo quote removal and word splitting, and any string that starts with a - is handled as tar command line option. If this behavior is undesirable, it can be turned off using the --verbatim-files-from option. The --null option instructs tar that the names in FILE are separated by ASCII NUL character, instead of LF. It is useful if the list is generated by find(1) -print0 predicate." }, { "flag": "", "long": "--unquote", "arg": null, "description": "Unquote file or member names (default)." }, { "flag": "", "long": "--verbatim-files-from", "arg": null, "description": "Treat each line obtained from a file list as a file name, even if it starts with a dash. File lists are supplied with the --files-from (-T) option. The default behav‐ ior is to handle names supplied in file lists as if they were typed in the command line, i.e. any names starting with a dash are treated as tar options. The --verba‐ tim-files-from option disables this behavior. This option affects all --files-from options that occur after it in the command line. Its effect is reverted by the --no-verbatim-files-from option. This option is implied by the --null option. See also --add-file." }, { "flag": "-X", "long": "--exclude-from", "arg": null, "description": "Exclude files matching patterns listed in FILE." }, { "flag": "", "long": "--anchored", "arg": null, "description": "Patterns match file name start." }, { "flag": "", "long": "--ignore-case", "arg": null, "description": "Ignore case." }, { "flag": "", "long": "--no-anchored", "arg": null, "description": "Patterns match after any / (default for exclusion)." }, { "flag": "", "long": "--no-ignore-case", "arg": null, "description": "Case sensitive matching (default)." }, { "flag": "", "long": "--no-wildcards", "arg": null, "description": "Verbatim string matching." }, { "flag": "", "long": "--no-wildcards-match-slash", "arg": null, "description": "Wildcards do not match /." }, { "flag": "", "long": "--wildcards", "arg": null, "description": "Use wildcards (default for exclusion)." }, { "flag": "", "long": "--wildcards-match-slash", "arg": null, "description": "Wildcards match / (default for exclusion)." }, { "flag": "", "long": "--clamp-mtime", "arg": null, "description": "Only set time when the file is more recent than what was given with --mtime." }, { "flag": "", "long": "--full-time", "arg": null, "description": "Print file time to its full resolution. --index-file=FILE Send verbose output to FILE." }, { "flag": "-l", "long": "--check-links", "arg": null, "description": "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 quoting style for file and member names. Valid values for STYLE are literal, shell, shell-always, c, c-maybe, escape, locale, clocale." }, { "flag": "-R", "long": "--block-number", "arg": null, "description": "Show block number within archive with each message." }, { "flag": "", "long": "--show-omitted-dirs", "arg": null, "description": "When listing or extracting, list each directory that does not match search criteria. --show-transformed-names, --show-stored-names Show file or archive names after transformation by --strip and --transform options. --totals[=SIGNAL] Print total bytes after processing the archive. If SIGNAL is given, print total bytes when this signal is delivered. Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1, and SIGUSR2. The SIG prefix can be omitted. --utc Print file modification times in UTC." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Verbosely list files processed. Each instance of this option on the command line in‐ creases the verbosity level by one. The maximum verbosity level is 3. For a detailed discussion of how various verbosity levels affect tar's output, please refer to GNU Tar Manual, subsection 2.5.2 \"The '--verbose' Option\". --warning=KEYWORD Enable or disable warning messages identified by KEYWORD. The messages are suppressed if KEYWORD is prefixed with no- and enabled otherwise. Multiple --warning options accumulate. Keywords controlling general tar operation: all Enable all warning messages. This is the default. none Disable all warning messages. filename-with-nuls \"%s: file name read contains nul character\" alone-zero-block \"A lone zero block at %s\" Keywords applicable for tar --create: cachedir \"%s: contains a cache directory tag %s; %s\" file-shrank \"%s: File shrank by %s bytes; padding with zeros\" xdev \"%s: file is on a different filesystem; not dumped\" file-ignored \"%s: Unknown file type; file ignored\" \"%s: socket ignored\" \"%s: door ignored\" file-unchanged \"%s: file is unchanged; not dumped\" ignore-archive \"%s: archive cannot contain itself; not dumped\" file-removed \"%s: File removed before we read it\" file-changed \"%s: file changed as we read it\" failed-read Suppresses warnings about unreadable files or directories. This keyword applies only if used together with the --ignore-failed-read option. Keywords applicable for tar --extract: existing-file \"%s: skipping existing file\" timestamp \"%s: implausibly old time stamp %s\" \"%s: time stamp %s is %s s in the future\" contiguous-cast \"Extracting contiguous files as regular files\" symlink-cast \"Attempting extraction of symbolic links as hard links\" unknown-cast \"%s: Unknown file type '%c', extracted as normal file\" ignore-newer \"Current %s is newer or same age\" unknown-keyword \"Ignoring unknown extended header keyword '%s'\" decompress-program Controls verbose description of failures occurring when trying to run alterna‐ tive decompressor programs. This warning is disabled by default (unless --ver‐ bose is used). A common example of what you can get when using this warning is: $ tar --warning=decompress-program -x -f archive.Z tar (child): cannot run compress: No such file or directory tar (child): trying gzip This means that tar first tried to decompress archive.Z using compress, and, when that failed, switched to gzip. record-size \"Record size = %lu blocks\" Keywords controlling incremental extraction: rename-directory \"%s: Directory has been renamed from %s\" \"%s: Directory has been renamed\" new-directory \"%s: Directory is new\" xdev \"%s: directory is on a different device: not purging\" bad-dumpdir \"Malformed dumpdir: 'X' never used\"" }, { "flag": "-w", "long": "--confirmation", "arg": null, "description": "Ask for confirmation for every action." }, { "flag": "-o", "long": "--no-same-owner", "arg": null, "description": "" } ], "examples": [], "see_also": [ { "name": "bzip2", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/bzip2/1/json" }, { "name": "compress", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/compress/1/json" }, { "name": "gzip", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/gzip/1/json" }, { "name": "lzma", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/lzma/1/json" }, { "name": "lzop", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/lzop/1/json" }, { "name": "rmt", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/rmt/8/json" }, { "name": "symlink", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/symlink/7/json" }, { "name": "xz", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/xz/1/json" }, { "name": "zstd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/zstd/1/json" }, { "name": "emacs", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/emacs/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 1, "subsections": [ { "name": "Traditional usage", "lines": 2 }, { "name": "UNIX-style usage", "lines": 14 }, { "name": "GNU-style usage", "lines": 18 } ] }, { "name": "NOTE", "lines": 16, "subsections": [] }, { "name": "DESCRIPTION", "lines": 5, "subsections": [ { "name": "Option styles", "lines": 46 }, { "name": "Operation mode", "lines": 4 }, { "name": "-A --catenate --concatenate", "lines": 9, "flag": "-A", "long": "--concatenate" }, { "name": "-c --create", "lines": 3, "flag": "-c", "long": "--create" }, { "name": "-d --diff --compare", "lines": 4, "flag": "-d", "long": "--compare" }, { "name": "--delete", "lines": 6, "long": "--delete" }, { "name": "-r --append", "lines": 3, "flag": "-r", "long": "--append" }, { "name": "-t --list", "lines": 3, "flag": "-t", "long": "--list" }, { "name": "--test-label", "lines": 8, "long": "--test-label" }, { "name": "-u --update", "lines": 6, "flag": "-u", "long": "--update" }, { "name": "-x --extract --get", "lines": 3, "flag": "-x", "long": "--get" }, { "name": "--show-defaults", "lines": 5, "long": "--show-defaults" }, { "name": "--usage", "lines": 2, "long": "--usage" }, { "name": "--version", "lines": 2, "long": "--version" } ] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "Operation modifiers", "lines": 1 }, { "name": "--check-device", "lines": 2, "long": "--check-device" }, { "name": "-g --listed-incremental", "lines": 17, "flag": "-g", "long": "--listed-incremental" }, { "name": "-G --incremental", "lines": 2, "flag": "-G", "long": "--incremental" }, { "name": "--ignore-failed-read", "lines": 7, "long": "--ignore-failed-read" }, { "name": "-n --seek", "lines": 5, "flag": "-n", "long": "--seek" }, { "name": "--no-check-device", "lines": 2, "long": "--no-check-device" }, { "name": "--no-seek", "lines": 8, "long": "--no-seek" }, { "name": "--restrict", "lines": 8, "long": "--restrict" }, { "name": "-S --sparse", "lines": 6, "flag": "-S", "long": "--sparse" }, { "name": "Overwrite control", "lines": 2 }, { "name": "-k --keep-old-files", "lines": 2, "flag": "-k", "long": "--keep-old-files" }, { "name": "--keep-newer-files", "lines": 2, "long": "--keep-newer-files" }, { "name": "--keep-directory-symlink", "lines": 2, "long": "--keep-directory-symlink" }, { "name": "--no-overwrite-dir", "lines": 7, "long": "--no-overwrite-dir" }, { "name": "--overwrite", "lines": 2, "long": "--overwrite" }, { "name": "--overwrite-dir", "lines": 2, "long": "--overwrite-dir" }, { "name": "--recursive-unlink", "lines": 2, "long": "--recursive-unlink" }, { "name": "--remove-files", "lines": 2, "long": "--remove-files" }, { "name": "--skip-old-files", "lines": 2, "long": "--skip-old-files" }, { "name": "-U --unlink-first", "lines": 2, "flag": "-U", "long": "--unlink-first" }, { "name": "-W --verify", "lines": 2, "flag": "-W", "long": "--verify" }, { "name": "Output stream selection", "lines": 1 }, { "name": "--ignore-command-error", "lines": 2, "long": "--ignore-command-error" }, { "name": "--no-ignore-command-error", "lines": 2, "long": "--no-ignore-command-error" }, { "name": "-O --to-stdout", "lines": 77, "flag": "-O", "long": "--to-stdout" }, { "name": "Handling of file attributes", "lines": 5 }, { "name": "--delay-directory-restore", "lines": 35, "long": "--delay-directory-restore" }, { "name": "-m --touch", "lines": 2, "flag": "-m", "long": "--touch" }, { "name": "--no-delay-directory-restore", "lines": 2, "long": "--no-delay-directory-restore" }, { "name": "--no-same-owner", "lines": 2, "long": "--no-same-owner" }, { "name": "--no-same-permissions", "lines": 3, "long": "--no-same-permissions" }, { "name": "--numeric-owner", "lines": 25, "long": "--numeric-owner" }, { "name": "-p --preserve-permissions --same-permissions", "lines": 3, "flag": "-p", "long": "--same-permissions" }, { "name": "--same-owner", "lines": 3, "long": "--same-owner" }, { "name": "-s --preserve-order --same-order", "lines": 17, "flag": "-s", "long": "--same-order" }, { "name": "Extended file attributes", "lines": 2 }, { "name": "--no-acls", "lines": 2, "long": "--no-acls" }, { "name": "--selinux", "lines": 2, "long": "--selinux" }, { "name": "--no-selinux", "lines": 2, "long": "--no-selinux" }, { "name": "--xattrs", "lines": 2, "long": "--xattrs" }, { "name": "--no-xattrs", "lines": 9, "long": "--no-xattrs" }, { "name": "Device selection and switching", "lines": 1 }, { "name": "-f --file", "lines": 23, "flag": "-f", "long": "--file" }, { "name": "--force-local", "lines": 2, "long": "--force-local" }, { "name": "-F --info-script --new-volume-script", "lines": 26, "flag": "-F", "long": "--new-volume-script" }, { "name": "-L --tape-length", "lines": 6, "flag": "-L", "long": "--tape-length" }, { "name": "-M --multi-volume", "lines": 14, "flag": "-M", "long": "--multi-volume" }, { "name": "Device blocking", "lines": 1 }, { "name": "-b --blocking-factor", "lines": 2, "flag": "-b", "long": "--blocking-factor" }, { "name": "-B --read-full-records", "lines": 2, "flag": "-B", "long": "--read-full-records" }, { "name": "-i --ignore-zeros", "lines": 9, "flag": "-i", "long": "--ignore-zeros" }, { "name": "Archive format selection", "lines": 1 }, { "name": "-H --format", "lines": 20, "flag": "-H", "long": "--format" }, { "name": "--posix", "lines": 2, "long": "--posix" }, { "name": "-V --label", "lines": 3, "flag": "-V", "long": "--label" }, { "name": "Compression options", "lines": 1 }, { "name": "-a --auto-compress", "lines": 2, "flag": "-a", "long": "--auto-compress" }, { "name": "-I --use-compress-program_", "lines": 3, "flag": "-I", "long": "--use-compress-program_" }, { "name": "-j --bzip2", "lines": 2, "flag": "-j", "long": "--bzip2" }, { "name": "-J --xz", "lines": 8, "flag": "-J", "long": "--xz" }, { "name": "--no-auto-compress", "lines": 2, "long": "--no-auto-compress" }, { "name": "-z --gzip --gunzip --ungzip", "lines": 2, "flag": "-z", "long": "--ungzip" }, { "name": "-Z --compress --uncompress", "lines": 4, "flag": "-Z", "long": "--uncompress" }, { "name": "Local file selection", "lines": 22 }, { "name": "-C --directory", "lines": 6, "flag": "-C", "long": "--directory" }, { "name": "--exclude-backups", "lines": 2, "long": "--exclude-backups" }, { "name": "--exclude-caches", "lines": 3, "long": "--exclude-caches" }, { "name": "--exclude-caches-all", "lines": 2, "long": "--exclude-caches-all" }, { "name": "--exclude-caches-under", "lines": 19, "long": "--exclude-caches-under" }, { "name": "--exclude-vcs", "lines": 2, "long": "--exclude-vcs" }, { "name": "--exclude-vcs-ignores", "lines": 3, "long": "--exclude-vcs-ignores" }, { "name": "-h --dereference", "lines": 2, "flag": "-h", "long": "--dereference" }, { "name": "--hard-dereference", "lines": 2, "long": "--hard-dereference" }, { "name": "-K --starting-file", "lines": 6, "flag": "-K", "long": "--starting-file" }, { "name": "--no-null", "lines": 2, "long": "--no-null" }, { "name": "--no-recursion", "lines": 2, "long": "--no-recursion" }, { "name": "--no-unquote", "lines": 2, "long": "--no-unquote" }, { "name": "--no-verbatim-files-from", "lines": 17, "long": "--no-verbatim-files-from" }, { "name": "-N --newer --after-date", "lines": 3, "flag": "-N", "long": "--after-date" }, { "name": "--one-file-system", "lines": 2, "long": "--one-file-system" }, { "name": "-P --absolute-names", "lines": 2, "flag": "-P", "long": "--absolute-names" }, { "name": "--recursion", "lines": 6, "long": "--recursion" }, { "name": "-T --files-from", "lines": 14, "flag": "-T", "long": "--files-from" }, { "name": "--unquote", "lines": 2, "long": "--unquote" }, { "name": "--verbatim-files-from", "lines": 13, "long": "--verbatim-files-from" }, { "name": "-X --exclude-from", "lines": 2, "flag": "-X", "long": "--exclude-from" }, { "name": "File name transformations", "lines": 6 }, { "name": "File name matching options", "lines": 2 }, { "name": "--anchored", "lines": 2, "long": "--anchored" }, { "name": "--ignore-case", "lines": 2, "long": "--ignore-case" }, { "name": "--no-anchored", "lines": 2, "long": "--no-anchored" }, { "name": "--no-ignore-case", "lines": 2, "long": "--no-ignore-case" }, { "name": "--no-wildcards", "lines": 2, "long": "--no-wildcards" }, { "name": "--no-wildcards-match-slash", "lines": 2, "long": "--no-wildcards-match-slash" }, { "name": "--wildcards", "lines": 2, "long": "--wildcards" }, { "name": "--wildcards-match-slash", "lines": 2, "long": "--wildcards-match-slash" }, { "name": "Informative output", "lines": 6 }, { "name": "--clamp-mtime", "lines": 2, "long": "--clamp-mtime" }, { "name": "--full-time", "lines": 5, "long": "--full-time" }, { "name": "-l --check-links", "lines": 12, "flag": "-l", "long": "--check-links" }, { "name": "-R --block-number", "lines": 2, "flag": "-R", "long": "--block-number" }, { "name": "--show-omitted-dirs", "lines": 12, "long": "--show-omitted-dirs" }, { "name": "-v --verbose", "lines": 108, "flag": "-v", "long": "--verbose" }, { "name": "-w --interactive --confirmation", "lines": 2, "flag": "-w", "long": "--confirmation" }, { "name": "Compatibility options", "lines": 1 }, { "name": "-o --old-archive --no-same-owner", "lines": 1, "flag": "-o", "long": "--no-same-owner" }, { "name": "Size suffixes", "lines": 12 } ] }, { "name": "RETURN VALUE", "lines": 18, "subsections": [] }, { "name": "SEE ALSO", "lines": 8, "subsections": [] }, { "name": "BUG REPORTS", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "tar - an archiving utility\n", "subsections": [] }, "SYNOPSIS": { "content": "", "subsections": [ { "name": "Traditional usage", "content": "tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ARG...]\n" }, { "name": "UNIX-style usage", "content": "tar -A [OPTIONS] -f ARCHIVE ARCHIVE...\n\ntar -c [-f ARCHIVE] [OPTIONS] [FILE...]\n\ntar -d [-f ARCHIVE] [OPTIONS] [FILE...]\n\ntar -r [-f ARCHIVE] [OPTIONS] [FILE...]\n\ntar -t [-f ARCHIVE] [OPTIONS] [MEMBER...]\n\ntar -u [-f ARCHIVE] [OPTIONS] [FILE...]\n\ntar -x [-f ARCHIVE] [OPTIONS] [MEMBER...]\n" }, { "name": "GNU-style usage", "content": "tar {--catenate|--concatenate} [OPTIONS] --file ARCHIVE ARCHIVE...\n\ntar --create [--file ARCHIVE] [OPTIONS] [FILE...]\n\ntar {--diff|--compare} [--file ARCHIVE] [OPTIONS] [FILE...]\n\ntar --delete [--file ARCHIVE] [OPTIONS] [MEMBER...]\n\ntar --append [--file ARCHIVE] [OPTIONS] [FILE...]\n\ntar --list [--file ARCHIVE] [OPTIONS] [MEMBER...]\n\ntar --test-label [--file ARCHIVE] [OPTIONS] [LABEL...]\n\ntar --update [--file ARCHIVE] [OPTIONS] [FILE...]\n\ntar {--extract|--get} [--file ARCHIVE] [OPTIONS] [MEMBER...]\n" } ] }, "NOTE": { "content": "This manpage is a short description of GNU tar. For a detailed discussion, including exam‐\nples and usage recommendations, refer to the GNU Tar Manual available in texinfo format. If\nthe info reader and the tar documentation are properly installed on your system, the command\n\ninfo tar\n\nshould give you access to the complete manual.\n\nYou can also view the manual using the info mode in emacs(1), or find it in various formats\nonline at\n\nhttps://www.gnu.org/software/tar/manual\n\nIf any discrepancies occur between this manpage and the GNU Tar Manual, the later shall be\nconsidered the authoritative source.\n", "subsections": [] }, "DESCRIPTION": { "content": "GNU tar is an archiving program designed to store multiple files in a single file (an\narchive), and to manipulate such archives. The archive can be either a regular file or a de‐\nvice (e.g. a tape drive, hence the name of the program, which stands for tape archiver),\nwhich can be located either on the local or on a remote machine.\n", "subsections": [ { "name": "Option styles", "content": "Options to GNU tar can be given in three different styles. In traditional style, the first\nargument is a cluster of option letters and all subsequent arguments supply arguments to\nthose options that require them. The arguments are read in the same order as the option let‐\nters. Any command line words that remain after all options have been processed are treated\nas non-option arguments: file or archive member names.\n\nFor example, the c option requires creating the archive, the v option requests the verbose\noperation, and the f option takes an argument that sets the name of the archive to operate\nupon. The following command, written in the traditional style, instructs tar to store all\nfiles from the directory /etc into the archive file etc.tar, verbosely listing the files be‐\ning archived:\n\ntar cfv etc.tar /etc\n\nIn UNIX or short-option style, each option letter is prefixed with a single dash, as in other\ncommand line utilities. If an option takes an argument, the argument follows it, either as a\nseparate command line word, or immediately following the option. However, if the option\ntakes an optional argument, the argument must follow the option letter without any interven‐\ning whitespace, as in -g/tmp/snar.db.\n\nAny number of options not taking arguments can be clustered together after a single dash,\ne.g. -vkp. An option that takes an argument (whether mandatory or optional) can appear at\nthe end of such a cluster, e.g. -vkpf a.tar.\n\nThe example command above written in the short-option style could look like:\n\ntar -cvf etc.tar /etc\nor\ntar -c -v -f etc.tar /etc\n\nIn GNU or long-option style, each option begins with two dashes and has a meaningful name,\nconsisting of lower-case letters and dashes. When used, the long option can be abbreviated\nto its initial letters, provided that this does not create ambiguity. Arguments to long op‐\ntions are supplied either as a separate command line word, immediately following the option,\nor separated from the option by an equals sign with no intervening whitespace. Optional ar‐\nguments must always use the latter method.\n\nHere are several ways of writing the example command in this style:\n\ntar --create --file etc.tar --verbose /etc\nor (abbreviating some options):\ntar --cre --file=etc.tar --verb /etc\n\nThe options in all three styles can be intermixed, although doing so with old options is not\nencouraged.\n" }, { "name": "Operation mode", "content": "The options listed in the table below tell GNU tar what operation it is to perform. Exactly\none of them must be given. The meaning of non-option arguments depends on the operation mode\nrequested.\n" }, { "name": "-A --catenate --concatenate", "content": "Append archives to the end of another archive. The arguments are treated as the names\nof archives to append. All archives must be of the same format as the archive they\nare appended to, otherwise the resulting archive might be unusable with non-GNU imple‐\nmentations of tar. Notice also that when more than one archive is given, the members\nfrom archives other than the first one will be accessible in the resulting archive\nonly when using the -i (--ignore-zeros) option.\n\nCompressed archives cannot be concatenated.\n", "flag": "-A", "long": "--concatenate" }, { "name": "-c --create", "content": "Create a new archive. Arguments supply the names of the files to be archived. Direc‐\ntories are archived recursively, unless the --no-recursion option is given.\n", "flag": "-c", "long": "--create" }, { "name": "-d --diff --compare", "content": "Find differences between archive and file system. The arguments are optional and\nspecify archive members to compare. If not given, the current working directory is\nassumed.\n", "flag": "-d", "long": "--compare" }, { "name": "--delete", "content": "Delete from the archive. The arguments supply names of the archive members to be re‐\nmoved. At least one argument must be given.\n\nThis option does not operate on compressed archives. There is no short option equiva‐\nlent.\n", "long": "--delete" }, { "name": "-r --append", "content": "Append files to the end of an archive. Arguments have the same meaning as for -c\n(--create).\n", "flag": "-r", "long": "--append" }, { "name": "-t --list", "content": "List the contents of an archive. Arguments are optional. When given, they specify\nthe names of the members to list.\n", "flag": "-t", "long": "--list" }, { "name": "--test-label", "content": "Test the archive volume label and exit. When used without arguments, it prints the\nvolume label (if any) and exits with status 0. When one or more command line argu‐\nments are given. tar compares the volume label with each argument. It exits with\ncode 0 if a match is found, and with code 1 otherwise. No output is displayed, unless\nused together with the -v (--verbose) option.\n\nThere is no short option equivalent for this option.\n", "long": "--test-label" }, { "name": "-u --update", "content": "Append files which are newer than the corresponding copy in the archive. Arguments\nhave the same meaning as with the -c and -r options. Notice, that newer files don't\nreplace their old archive copies, but instead are appended to the end of archive. The\nresulting archive can thus contain several members of the same name, corresponding to\nvarious versions of the same file.\n", "flag": "-u", "long": "--update" }, { "name": "-x --extract --get", "content": "Extract files from an archive. Arguments are optional. When given, they specify\nnames of the archive members to be extracted.\n", "flag": "-x", "long": "--get" }, { "name": "--show-defaults", "content": "Show built-in defaults for various tar options and exit.\n\n-?, --help\nDisplay a short option summary and exit.\n", "long": "--show-defaults" }, { "name": "--usage", "content": "Display a list of available options and exit.\n", "long": "--usage" }, { "name": "--version", "content": "Print program version and copyright information and exit.\n", "long": "--version" } ] }, "OPTIONS": { "content": "", "subsections": [ { "name": "Operation modifiers", "content": "" }, { "name": "--check-device", "content": "Check device numbers when creating incremental archives (default).\n", "long": "--check-device" }, { "name": "-g --listed-incremental", "content": "Handle new GNU-format incremental backups. FILE is the name of a snapshot file, where\ntar stores additional information which is used to decide which files changed since\nthe previous incremental dump and, consequently, must be dumped again. If FILE does\nnot exist when creating an archive, it will be created and all files will be added to\nthe resulting archive (the level 0 dump). To create incremental archives of non-zero\nlevel N, you need a copy of the snapshot file created for level N-1, and use it as\nFILE.\n\nWhen listing or extracting, the actual content of FILE is not inspected, it is needed\nonly due to syntactical requirements. It is therefore common practice to use\n/dev/null in its place.\n\n--hole-detection=METHOD\nUse METHOD to detect holes in sparse files. This option implies --sparse. Valid val‐\nues for METHOD are seek and raw. Default is seek with fallback to raw when not ap‐\nplicable.\n", "flag": "-g", "long": "--listed-incremental" }, { "name": "-G --incremental", "content": "Handle old GNU-format incremental backups.\n", "flag": "-G", "long": "--incremental" }, { "name": "--ignore-failed-read", "content": "Do not exit with nonzero on unreadable files.\n\n--level=NUMBER\nSet dump level for a created listed-incremental archive. Currently only --level=0 is\nmeaningful: it instructs tar to truncate the snapshot file before dumping, thereby\nforcing a level 0 dump.\n", "long": "--ignore-failed-read" }, { "name": "-n --seek", "content": "Assume the archive is seekable. Normally tar determines automatically whether the\narchive can be seeked or not. This option is intended for use in cases when such\nrecognition fails. It takes effect only if the archive is open for reading (e.g. with\n--list or --extract options).\n", "flag": "-n", "long": "--seek" }, { "name": "--no-check-device", "content": "Do not check device numbers when creating incremental archives.\n", "long": "--no-check-device" }, { "name": "--no-seek", "content": "Assume the archive is not seekable.\n\n--occurrence[=N]\nProcess only the Nth occurrence of each file in the archive. This option is valid\nonly when used with one of the following subcommands: --delete, --diff, --extract or\n--list and when a list of files is given either on the command line or via the -T op‐\ntion. The default N is 1.\n", "long": "--no-seek" }, { "name": "--restrict", "content": "Disable the use of some potentially harmful options.\n\n--sparse-version=MAJOR[.MINOR]\nSet which version of the sparse format to use. This option implies --sparse. Valid\nargument values are 0.0, 0.1, and 1.0. For a detailed discussion of sparse formats,\nrefer to the GNU Tar Manual, appendix D, \"Sparse Formats\". Using the info reader, it\ncan be accessed running the following command: info tar 'Sparse Formats'.\n", "long": "--restrict" }, { "name": "-S --sparse", "content": "Handle sparse files efficiently. Some files in the file system may have segments\nwhich were actually never written (quite often these are database files created by\nsuch systems as DBM). When given this option, tar attempts to determine if the file\nis sparse prior to archiving it, and if so, to reduce the resulting archive size by\nnot dumping empty parts of the file.\n", "flag": "-S", "long": "--sparse" }, { "name": "Overwrite control", "content": "These options control tar actions when extracting a file over an existing copy on disk.\n" }, { "name": "-k --keep-old-files", "content": "Don't replace existing files when extracting.\n", "flag": "-k", "long": "--keep-old-files" }, { "name": "--keep-newer-files", "content": "Don't replace existing files that are newer than their archive copies.\n", "long": "--keep-newer-files" }, { "name": "--keep-directory-symlink", "content": "Don't replace existing symlinks to directories when extracting.\n", "long": "--keep-directory-symlink" }, { "name": "--no-overwrite-dir", "content": "Preserve metadata of existing directories.\n\n--one-top-level[=DIR]\nExtract all files into DIR, or, if used without argument, into a subdirectory named by\nthe base name of the archive (minus standard compression suffixes recognizable by\n--auto-compress).\n", "long": "--no-overwrite-dir" }, { "name": "--overwrite", "content": "Overwrite existing files when extracting.\n", "long": "--overwrite" }, { "name": "--overwrite-dir", "content": "Overwrite metadata of existing directories when extracting (default).\n", "long": "--overwrite-dir" }, { "name": "--recursive-unlink", "content": "Recursively remove all files in the directory prior to extracting it.\n", "long": "--recursive-unlink" }, { "name": "--remove-files", "content": "Remove files from disk after adding them to the archive.\n", "long": "--remove-files" }, { "name": "--skip-old-files", "content": "Don't replace existing files when extracting, silently skip over them.\n", "long": "--skip-old-files" }, { "name": "-U --unlink-first", "content": "Remove each file prior to extracting over it.\n", "flag": "-U", "long": "--unlink-first" }, { "name": "-W --verify", "content": "Verify the archive after writing it.\n", "flag": "-W", "long": "--verify" }, { "name": "Output stream selection", "content": "" }, { "name": "--ignore-command-error", "content": "Ignore subprocess exit codes.\n", "long": "--ignore-command-error" }, { "name": "--no-ignore-command-error", "content": "Treat non-zero exit codes of children as error (default).\n", "long": "--no-ignore-command-error" }, { "name": "-O --to-stdout", "content": "Extract files to standard output.\n\n--to-command=COMMAND\nPipe extracted files to COMMAND. The argument is the pathname of an external program,\noptionally with command line arguments. The program will be invoked and the contents\nof the file being extracted supplied to it on its standard input. Additional data\nwill be supplied via the following environment variables:\n\nTARFILETYPE\nType of the file. It is a single letter with the following meaning:\n\nf Regular file\nd Directory\nl Symbolic link\nh Hard link\nb Block device\nc Character device\n\nCurrently only regular files are supported.\n\nTARMODE\nFile mode, an octal number.\n\nTARFILENAME\nThe name of the file.\n\nTARREALNAME\nName of the file as stored in the archive.\n\nTARUNAME\nName of the file owner.\n\nTARGNAME\nName of the file owner group.\n\nTARATIME\nTime of last access. It is a decimal number, representing seconds since the\nEpoch. If the archive provides times with nanosecond precision, the nanosec‐\nonds are appended to the timestamp after a decimal point.\n\nTARMTIME\nTime of last modification.\n\nTARCTIME\nTime of last status change.\n\nTARSIZE\nSize of the file.\n\nTARUID\nUID of the file owner.\n\nTARGID\nGID of the file owner.\n\nAdditionally, the following variables contain information about tar operation mode and\nthe archive being processed:\n\nTARVERSION\nGNU tar version number.\n\nTARARCHIVE\nThe name of the archive tar is processing.\n\nTARBLOCKINGFACTOR\nCurrent blocking factor, i.e. number of 512-byte blocks in a record.\n\nTARVOLUME\nOrdinal number of the volume tar is processing (set if reading a multi-volume\narchive).\n\nTARFORMAT\nFormat of the archive being processed. One of: gnu, oldgnu, posix, ustar, v7.\n\nTARSUBCOMMAND\nA short option (with a leading dash) describing the operation tar is executing.\n", "flag": "-O", "long": "--to-stdout" }, { "name": "Handling of file attributes", "content": "--atime-preserve[=METHOD]\nPreserve access times on dumped files, either by restoring the times after reading\n(METHOD=replace, this is the default) or by not setting the times in the first place\n(METHOD=system).\n" }, { "name": "--delay-directory-restore", "content": "Delay setting modification times and permissions of extracted directories until the\nend of extraction. Use this option when extracting from an archive which has unusual\nmember ordering.\n\n--group=NAME[:GID]\nForce NAME as group for added files. If GID is not supplied, NAME can be either a\nuser name or numeric GID. In this case the missing part (GID or name) will be in‐\nferred from the current host's group database.\n\nWhen used with --group-map=FILE, affects only those files whose owner group is not\nlisted in FILE.\n\n--group-map=FILE\nRead group translation map from FILE. Empty lines are ignored. Comments are intro‐\nduced with # sign and extend to the end of line. Each non-empty line in FILE defines\ntranslation for a single group. It must consist of two fields, delimited by any\namount of whitespace:\n\nOLDGRP NEWGRP[:NEWGID]\n\nOLDGRP is either a valid group name or a GID prefixed with +. Unless NEWGID is sup‐\nplied, NEWGRP must also be either a valid group name or a +GID. Otherwise, both NEW‐\nGRP and NEWGID need not be listed in the system group database.\n\nAs a result, each input file with owner group OLDGRP will be stored in archive with\nowner group NEWGRP and GID NEWGID.\n\n--mode=CHANGES\nForce symbolic mode CHANGES for added files.\n\n--mtime=DATE-OR-FILE\nSet mtime for added files. DATE-OR-FILE is either a date/time in almost arbitrary\nformat, or the name of an existing file. In the latter case the mtime of that file\nwill be used.\n", "long": "--delay-directory-restore" }, { "name": "-m --touch", "content": "Don't extract file modified time.\n", "flag": "-m", "long": "--touch" }, { "name": "--no-delay-directory-restore", "content": "Cancel the effect of the prior --delay-directory-restore option.\n", "long": "--no-delay-directory-restore" }, { "name": "--no-same-owner", "content": "Extract files as yourself (default for ordinary users).\n", "long": "--no-same-owner" }, { "name": "--no-same-permissions", "content": "Apply the user's umask when extracting permissions from the archive (default for ordi‐\nnary users).\n", "long": "--no-same-permissions" }, { "name": "--numeric-owner", "content": "Always use numbers for user/group names.\n\n--owner=NAME[:UID]\nForce NAME as owner for added files. If UID is not supplied, NAME can be either a\nuser name or numeric UID. In this case the missing part (UID or name) will be in‐\nferred from the current host's user database.\n\nWhen used with --owner-map=FILE, affects only those files whose owner is not listed in\nFILE.\n\n--owner-map=FILE\nRead owner translation map from FILE. Empty lines are ignored. Comments are intro‐\nduced with # sign and extend to the end of line. Each non-empty line in FILE defines\ntranslation for a single UID. It must consist of two fields, delimited by any amount\nof whitespace:\n\nOLDUSR NEWUSR[:NEWUID]\n\nOLDUSR is either a valid user name or a UID prefixed with +. Unless NEWUID is sup‐\nplied, NEWUSR must also be either a valid user name or a +UID. Otherwise, both NEWUSR\nand NEWUID need not be listed in the system user database.\n\nAs a result, each input file owned by OLDUSR will be stored in archive with owner name\nNEWUSR and UID NEWUID.\n", "long": "--numeric-owner" }, { "name": "-p --preserve-permissions --same-permissions", "content": "Set permissions of extracted files to those recorded in the archive (default for supe‐\nruser).\n", "flag": "-p", "long": "--same-permissions" }, { "name": "--same-owner", "content": "Try extracting files with the same ownership as exists in the archive (default for su‐\nperuser).\n", "long": "--same-owner" }, { "name": "-s --preserve-order --same-order", "content": "Tell tar that the list of file names to process is sorted in the same order as the\nfiles in the archive.\n\n--sort=ORDER\nWhen creating an archive, sort directory entries according to ORDER, which is one of\nnone, name, or inode.\n\nThe default is --sort=none, which stores archive members in the same order as returned\nby the operating system.\n\nUsing --sort=name ensures the member ordering in the created archive is uniform and\nreproducible.\n\nUsing --sort=inode reduces the number of disk seeks made when creating the archive and\nthus can considerably speed up archivation. This sorting order is supported only if\nthe underlying system provides the necessary information.\n", "flag": "-s", "long": "--same-order" }, { "name": "Extended file attributes", "content": "--acls Enable POSIX ACLs support.\n" }, { "name": "--no-acls", "content": "Disable POSIX ACLs support.\n", "long": "--no-acls" }, { "name": "--selinux", "content": "Enable SELinux context support.\n", "long": "--selinux" }, { "name": "--no-selinux", "content": "Disable SELinux context support.\n", "long": "--no-selinux" }, { "name": "--xattrs", "content": "Enable extended attributes support.\n", "long": "--xattrs" }, { "name": "--no-xattrs", "content": "Disable extended attributes support.\n\n--xattrs-exclude=PATTERN\nSpecify the exclude pattern for xattr keys. PATTERN is a globbing pattern, e.g.\n--xattrs-exclude='user.*' to include only attributes from the user namespace.\n\n--xattrs-include=PATTERN\nSpecify the include pattern for xattr keys. PATTERN is a globbing pattern.\n", "long": "--no-xattrs" }, { "name": "Device selection and switching", "content": "" }, { "name": "-f --file", "content": "Use archive file or device ARCHIVE. If this option is not given, tar will first exam‐\nine the environment variable `TAPE'. If it is set, its value will be used as the\narchive name. Otherwise, tar will assume the compiled-in default. The default value\ncan be inspected either using the --show-defaults option, or at the end of the tar\n--help output.\n\nAn archive name that has a colon in it specifies a file or device on a remote machine.\nThe part before the colon is taken as the machine name or IP address, and the part af‐\nter it as the file or device pathname, e.g.:\n\n--file=remotehost:/dev/sr0\n\nAn optional username can be prefixed to the hostname, placing a @ sign between them.\n\nBy default, the remote host is accessed via the rsh(1) command. Nowadays it is common\nto use ssh(1) instead. You can do so by giving the following command line option:\n\n--rsh-command=/usr/bin/ssh\n\nThe remote machine should have the rmt(8) command installed. If its pathname does not\nmatch tar's default, you can inform tar about the correct pathname using the\n--rmt-command option.\n", "flag": "-f", "long": "--file" }, { "name": "--force-local", "content": "Archive file is local even if it has a colon.\n", "long": "--force-local" }, { "name": "-F --info-script --new-volume-script", "content": "Run COMMAND at the end of each tape (implies -M). The command can include arguments.\nWhen started, it will inherit tar's environment plus the following variables:\n\nTARVERSION\nGNU tar version number.\n\nTARARCHIVE\nThe name of the archive tar is processing.\n\nTARBLOCKINGFACTOR\nCurrent blocking factor, i.e. number of 512-byte blocks in a record.\n\nTARVOLUME\nOrdinal number of the volume tar is processing (set if reading a multi-volume\narchive).\n\nTARFORMAT\nFormat of the archive being processed. One of: gnu, oldgnu, posix, ustar, v7.\n\nTARSUBCOMMAND\nA short option (with a leading dash) describing the operation tar is executing.\n\nTARFD File descriptor which can be used to communicate the new volume name to tar.\n\nIf the info script fails, tar exits; otherwise, it begins writing the next volume.\n", "flag": "-F", "long": "--new-volume-script" }, { "name": "-L --tape-length", "content": "Change tape after writing Nx1024 bytes. If N is followed by a size suffix (see the\nsubsection Size suffixes below), the suffix specifies the multiplicative factor to be\nused instead of 1024.\n\nThis option implies -M.\n", "flag": "-L", "long": "--tape-length" }, { "name": "-M --multi-volume", "content": "Create/list/extract multi-volume archive.\n\n--rmt-command=COMMAND\nUse COMMAND instead of rmt when accessing remote archives. See the description of the\n-f option, above.\n\n--rsh-command=COMMAND\nUse COMMAND instead of rsh when accessing remote archives. See the description of the\n-f option, above.\n\n--volno-file=FILE\nWhen this option is used in conjunction with --multi-volume, tar will keep track of\nwhich volume of a multi-volume archive it is working in FILE.\n", "flag": "-M", "long": "--multi-volume" }, { "name": "Device blocking", "content": "" }, { "name": "-b --blocking-factor", "content": "Set record size to BLOCKSx512 bytes.\n", "flag": "-b", "long": "--blocking-factor" }, { "name": "-B --read-full-records", "content": "When listing or extracting, accept incomplete input records after end-of-file marker.\n", "flag": "-B", "long": "--read-full-records" }, { "name": "-i --ignore-zeros", "content": "Ignore zeroed blocks in archive. Normally two consecutive 512-blocks filled with ze‐\nroes mean EOF and tar stops reading after encountering them. This option instructs it\nto read further and is useful when reading archives created with the -A option.\n\n--record-size=NUMBER\nSet record size. NUMBER is the number of bytes per record. It must be multiple of\n512. It can can be suffixed with a size suffix, e.g. --record-size=10K, for 10 Kilo‐\nbytes. See the subsection Size suffixes, for a list of valid suffixes.\n", "flag": "-i", "long": "--ignore-zeros" }, { "name": "Archive format selection", "content": "" }, { "name": "-H --format", "content": "Create archive of the given format. Valid formats are:\n\ngnu GNU tar 1.13.x format\n\noldgnu GNU format as per tar <= 1.12.\n\npax, posix\nPOSIX 1003.1-2001 (pax) format.\n\nustar POSIX 1003.1-1988 (ustar) format.\n\nv7 Old V7 tar format.\n\n--old-archive, --portability\nSame as --format=v7.\n\n--pax-option=keyword[[:]=value][,keyword[[:]=value]]...\nControl pax keywords when creating PAX archives (-H pax). This option is equivalent\nto the -o option of the pax(1) utility.\n", "flag": "-H", "long": "--format" }, { "name": "--posix", "content": "Same as --format=posix.\n", "long": "--posix" }, { "name": "-V --label", "content": "Create archive with volume name TEXT. If listing or extracting, use TEXT as a glob‐\nbing pattern for volume name.\n", "flag": "-V", "long": "--label" }, { "name": "Compression options", "content": "" }, { "name": "-a --auto-compress", "content": "Use archive suffix to determine the compression program.\n", "flag": "-a", "long": "--auto-compress" }, { "name": "-I --use-compress-program_", "content": "Filter data through COMMAND. It must accept the -d option, for decompression. The\nargument can contain command line options.\n", "flag": "-I", "long": "--use-compress-program_" }, { "name": "-j --bzip2", "content": "Filter the archive through bzip2(1).\n", "flag": "-j", "long": "--bzip2" }, { "name": "-J --xz", "content": "Filter the archive through xz(1).\n\n--lzip Filter the archive through lzip(1).\n\n--lzma Filter the archive through lzma(1).\n\n--lzop Filter the archive through lzop(1).\n", "flag": "-J", "long": "--xz" }, { "name": "--no-auto-compress", "content": "Do not use archive suffix to determine the compression program.\n", "long": "--no-auto-compress" }, { "name": "-z --gzip --gunzip --ungzip", "content": "Filter the archive through gzip(1).\n", "flag": "-z", "long": "--ungzip" }, { "name": "-Z --compress --uncompress", "content": "Filter the archive through compress(1).\n\n--zstd Filter the archive through zstd(1).\n", "flag": "-Z", "long": "--uncompress" }, { "name": "Local file selection", "content": "--add-file=FILE\nAdd FILE to the archive (useful if its name starts with a dash).\n\n--backup[=CONTROL]\nBackup before removal. The CONTROL argument, if supplied, controls the backup policy.\nIts valid values are:\n\nnone, off\nNever make backups.\n\nt, numbered\nMake numbered backups.\n\nnil, existing\nMake numbered backups if numbered backups exist, simple backups otherwise.\n\nnever, simple\nAlways make simple backups\n\nIf CONTROL is not given, the value is taken from the VERSIONCONTROL environment vari‐\nable. If it is not set, existing is assumed.\n" }, { "name": "-C --directory", "content": "Change to DIR before performing any operations. This option is order-sensitive, i.e.\nit affects all options that follow.\n\n--exclude=PATTERN\nExclude files matching PATTERN, a glob(3)-style wildcard pattern.\n", "flag": "-C", "long": "--directory" }, { "name": "--exclude-backups", "content": "Exclude backup and lock files.\n", "long": "--exclude-backups" }, { "name": "--exclude-caches", "content": "Exclude contents of directories containing file CACHEDIR.TAG, except for the tag file\nitself.\n", "long": "--exclude-caches" }, { "name": "--exclude-caches-all", "content": "Exclude directories containing file CACHEDIR.TAG and the file itself.\n", "long": "--exclude-caches-all" }, { "name": "--exclude-caches-under", "content": "Exclude everything under directories containing CACHEDIR.TAG\n\n--exclude-ignore=FILE\nBefore dumping a directory, see if it contains FILE. If so, read exclusion patterns\nfrom this file. The patterns affect only the directory itself.\n\n--exclude-ignore-recursive=FILE\nSame as --exclude-ignore, except that patterns from FILE affect both the directory and\nall its subdirectories.\n\n--exclude-tag=FILE\nExclude contents of directories containing FILE, except for FILE itself.\n\n--exclude-tag-all=FILE\nExclude directories containing FILE.\n\n--exclude-tag-under=FILE\nExclude everything under directories containing FILE.\n", "long": "--exclude-caches-under" }, { "name": "--exclude-vcs", "content": "Exclude version control system directories.\n", "long": "--exclude-vcs" }, { "name": "--exclude-vcs-ignores", "content": "Exclude files that match patterns read from VCS-specific ignore files. Supported\nfiles are: .cvsignore, .gitignore, .bzrignore, and .hgignore.\n", "long": "--exclude-vcs-ignores" }, { "name": "-h --dereference", "content": "Follow symlinks; archive and dump the files they point to.\n", "flag": "-h", "long": "--dereference" }, { "name": "--hard-dereference", "content": "Follow hard links; archive and dump the files they refer to.\n", "long": "--hard-dereference" }, { "name": "-K --starting-file", "content": "Begin at the given member in the archive.\n\n--newer-mtime=DATE\nWork on files whose data changed after the DATE. If DATE starts with / or . it is\ntaken to be a file name; the mtime of that file is used as the date.\n", "flag": "-K", "long": "--starting-file" }, { "name": "--no-null", "content": "Disable the effect of the previous --null option.\n", "long": "--no-null" }, { "name": "--no-recursion", "content": "Avoid descending automatically in directories.\n", "long": "--no-recursion" }, { "name": "--no-unquote", "content": "Do not unquote input file or member names.\n", "long": "--no-unquote" }, { "name": "--no-verbatim-files-from", "content": "Treat each line read from a file list as if it were supplied in the command line.\nI.e., leading and trailing whitespace is removed and, if the resulting string begins\nwith a dash, it is treated as tar command line option.\n\nThis is the default behavior. The --no-verbatim-files-from option is provided as a\nway to restore it after --verbatim-files-from option.\n\nThis option is positional: it affects all --files-from options that occur after it in,\nuntil --verbatim-files-from option or end of line, whichever occurs first.\n\nIt is implied by the --no-null option.\n\n--null Instruct subsequent -T options to read null-terminated names verbatim (disables spe‐\ncial handling of names that start with a dash).\n\nSee also --verbatim-files-from.\n", "long": "--no-verbatim-files-from" }, { "name": "-N --newer --after-date", "content": "Only store files newer than DATE. If DATE starts with / or . it is taken to be a file\nname; the mtime of that file is used as the date.\n", "flag": "-N", "long": "--after-date" }, { "name": "--one-file-system", "content": "Stay in local file system when creating archive.\n", "long": "--one-file-system" }, { "name": "-P --absolute-names", "content": "Don't strip leading slashes from file names when creating archives.\n", "flag": "-P", "long": "--absolute-names" }, { "name": "--recursion", "content": "Recurse into directories (default).\n\n--suffix=STRING\nBackup before removal, override usual suffix. Default suffix is ~, unless overridden\nby environment variable SIMPLEBACKUPSUFFIX.\n", "long": "--recursion" }, { "name": "-T --files-from", "content": "Get names to extract or create from FILE.\n\nUnless specified otherwise, the FILE must contain a list of names separated by ASCII\nLF (i.e. one name per line). The names read are handled the same way as command line\narguments. They undergo quote removal and word splitting, and any string that starts\nwith a - is handled as tar command line option.\n\nIf this behavior is undesirable, it can be turned off using the --verbatim-files-from\noption.\n\nThe --null option instructs tar that the names in FILE are separated by ASCII NUL\ncharacter, instead of LF. It is useful if the list is generated by find(1) -print0\npredicate.\n", "flag": "-T", "long": "--files-from" }, { "name": "--unquote", "content": "Unquote file or member names (default).\n", "long": "--unquote" }, { "name": "--verbatim-files-from", "content": "Treat each line obtained from a file list as a file name, even if it starts with a\ndash. File lists are supplied with the --files-from (-T) option. The default behav‐\nior is to handle names supplied in file lists as if they were typed in the command\nline, i.e. any names starting with a dash are treated as tar options. The --verba‐\ntim-files-from option disables this behavior.\n\nThis option affects all --files-from options that occur after it in the command line.\nIts effect is reverted by the --no-verbatim-files-from option.\n\nThis option is implied by the --null option.\n\nSee also --add-file.\n", "long": "--verbatim-files-from" }, { "name": "-X --exclude-from", "content": "Exclude files matching patterns listed in FILE.\n", "flag": "-X", "long": "--exclude-from" }, { "name": "File name transformations", "content": "--strip-components=NUMBER\nStrip NUMBER leading components from file names on extraction.\n\n--transform=EXPRESSION, --xform=EXPRESSION\nUse sed replace EXPRESSION to transform file names.\n" }, { "name": "File name matching options", "content": "These options affect both exclude and include patterns.\n" }, { "name": "--anchored", "content": "Patterns match file name start.\n", "long": "--anchored" }, { "name": "--ignore-case", "content": "Ignore case.\n", "long": "--ignore-case" }, { "name": "--no-anchored", "content": "Patterns match after any / (default for exclusion).\n", "long": "--no-anchored" }, { "name": "--no-ignore-case", "content": "Case sensitive matching (default).\n", "long": "--no-ignore-case" }, { "name": "--no-wildcards", "content": "Verbatim string matching.\n", "long": "--no-wildcards" }, { "name": "--no-wildcards-match-slash", "content": "Wildcards do not match /.\n", "long": "--no-wildcards-match-slash" }, { "name": "--wildcards", "content": "Use wildcards (default for exclusion).\n", "long": "--wildcards" }, { "name": "--wildcards-match-slash", "content": "Wildcards match / (default for exclusion).\n", "long": "--wildcards-match-slash" }, { "name": "Informative output", "content": "--checkpoint[=N]\nDisplay progress messages every Nth record (default 10).\n\n--checkpoint-action=ACTION\nRun ACTION on each checkpoint.\n" }, { "name": "--clamp-mtime", "content": "Only set time when the file is more recent than what was given with --mtime.\n", "long": "--clamp-mtime" }, { "name": "--full-time", "content": "Print file time to its full resolution.\n\n--index-file=FILE\nSend verbose output to FILE.\n", "long": "--full-time" }, { "name": "-l --check-links", "content": "Print a message if not all links are dumped.\n\n--no-quote-chars=STRING\nDisable quoting for characters from STRING.\n\n--quote-chars=STRING\nAdditionally quote characters from STRING.\n\n--quoting-style=STYLE\nSet quoting style for file and member names. Valid values for STYLE are literal,\nshell, shell-always, c, c-maybe, escape, locale, clocale.\n", "flag": "-l", "long": "--check-links" }, { "name": "-R --block-number", "content": "Show block number within archive with each message.\n", "flag": "-R", "long": "--block-number" }, { "name": "--show-omitted-dirs", "content": "When listing or extracting, list each directory that does not match search criteria.\n\n--show-transformed-names, --show-stored-names\nShow file or archive names after transformation by --strip and --transform options.\n\n--totals[=SIGNAL]\nPrint total bytes after processing the archive. If SIGNAL is given, print total bytes\nwhen this signal is delivered. Allowed signals are: SIGHUP, SIGQUIT, SIGINT, SIGUSR1,\nand SIGUSR2. The SIG prefix can be omitted.\n\n--utc Print file modification times in UTC.\n", "long": "--show-omitted-dirs" }, { "name": "-v --verbose", "content": "Verbosely list files processed. Each instance of this option on the command line in‐\ncreases the verbosity level by one. The maximum verbosity level is 3. For a detailed\ndiscussion of how various verbosity levels affect tar's output, please refer to GNU\nTar Manual, subsection 2.5.2 \"The '--verbose' Option\".\n\n--warning=KEYWORD\nEnable or disable warning messages identified by KEYWORD. The messages are suppressed\nif KEYWORD is prefixed with no- and enabled otherwise.\n\nMultiple --warning options accumulate.\n\nKeywords controlling general tar operation:\n\nall Enable all warning messages. This is the default.\n\nnone Disable all warning messages.\n\nfilename-with-nuls\n\"%s: file name read contains nul character\"\n\nalone-zero-block\n\"A lone zero block at %s\"\n\nKeywords applicable for tar --create:\n\ncachedir\n\"%s: contains a cache directory tag %s; %s\"\n\nfile-shrank\n\"%s: File shrank by %s bytes; padding with zeros\"\n\nxdev \"%s: file is on a different filesystem; not dumped\"\n\nfile-ignored\n\"%s: Unknown file type; file ignored\"\n\"%s: socket ignored\"\n\"%s: door ignored\"\n\nfile-unchanged\n\"%s: file is unchanged; not dumped\"\n\nignore-archive\n\"%s: archive cannot contain itself; not dumped\"\n\nfile-removed\n\"%s: File removed before we read it\"\n\nfile-changed\n\"%s: file changed as we read it\"\n\nfailed-read\nSuppresses warnings about unreadable files or directories. This keyword applies\nonly if used together with the --ignore-failed-read option.\n\nKeywords applicable for tar --extract:\n\nexisting-file\n\"%s: skipping existing file\"\n\ntimestamp\n\"%s: implausibly old time stamp %s\"\n\"%s: time stamp %s is %s s in the future\"\n\ncontiguous-cast\n\"Extracting contiguous files as regular files\"\n\nsymlink-cast\n\"Attempting extraction of symbolic links as hard links\"\n\nunknown-cast\n\"%s: Unknown file type '%c', extracted as normal file\"\n\nignore-newer\n\"Current %s is newer or same age\"\n\nunknown-keyword\n\"Ignoring unknown extended header keyword '%s'\"\n\ndecompress-program\nControls verbose description of failures occurring when trying to run alterna‐\ntive decompressor programs. This warning is disabled by default (unless --ver‐\nbose is used). A common example of what you can get when using this warning\nis:\n\n$ tar --warning=decompress-program -x -f archive.Z\ntar (child): cannot run compress: No such file or directory\ntar (child): trying gzip\n\nThis means that tar first tried to decompress archive.Z using compress, and,\nwhen that failed, switched to gzip.\n\nrecord-size\n\"Record size = %lu blocks\"\n\nKeywords controlling incremental extraction:\n\nrename-directory\n\"%s: Directory has been renamed from %s\"\n\"%s: Directory has been renamed\"\n\nnew-directory\n\"%s: Directory is new\"\n\nxdev \"%s: directory is on a different device: not purging\"\n\nbad-dumpdir\n\"Malformed dumpdir: 'X' never used\"\n", "flag": "-v", "long": "--verbose" }, { "name": "-w --interactive --confirmation", "content": "Ask for confirmation for every action.\n", "flag": "-w", "long": "--confirmation" }, { "name": "Compatibility options", "content": "" }, { "name": "-o --old-archive --no-same-owner", "content": "", "flag": "-o", "long": "--no-same-owner" }, { "name": "Size suffixes", "content": "Suffix Units Byte Equivalent\nb Blocks SIZE x 512\nB Kilobytes SIZE x 1024\nc Bytes SIZE\nG Gigabytes SIZE x 1024^3\nK Kilobytes SIZE x 1024\nk Kilobytes SIZE x 1024\nM Megabytes SIZE x 1024^2\nP Petabytes SIZE x 1024^5\nT Terabytes SIZE x 1024^4\nw Words SIZE x 2\n" } ] }, "RETURN VALUE": { "content": "Tar's exit code indicates whether it was able to successfully perform the requested opera‐\ntion, and if not, what kind of error occurred.\n\n0 Successful termination.\n\n1 Some files differ. If tar was invoked with the --compare (--diff, -d) command line\noption, this means that some files in the archive differ from their disk counterparts.\nIf tar was given one of the --create, --append or --update options, this exit code\nmeans that some files were changed while being archived and so the resulting archive\ndoes not contain the exact copy of the file set.\n\n2 Fatal error. This means that some fatal, unrecoverable error occurred.\n\nIf a subprocess that had been invoked by tar exited with a nonzero exit code, tar itself ex‐\nits with that code as well. This can happen, for example, if a compression option (e.g. -z)\nwas used and the external compressor program failed. Another example is rmt failure during\nbackup to a remote device.\n", "subsections": [] }, "SEE ALSO": { "content": "bzip2(1), compress(1), gzip(1), lzma(1), lzop(1), rmt(8), symlink(7), xz(1), zstd(1).\n\nComplete tar manual: run info tar or use emacs(1) info mode to read it.\n\nOnline copies of GNU tar documentation in various formats can be found at:\n\nhttps://www.gnu.org/software/tar/manual\n", "subsections": [] }, "BUG REPORTS": { "content": "Report bugs to .\n", "subsections": [] }, "COPYRIGHT": { "content": "Copyright © 2023 Free Software Foundation, Inc.\nLicense GPLv3+: GNU GPL version 3 or later \nThis is free software: you are free to change and redistribute it. There is NO WARRANTY, to\nthe extent permitted by law.\n\nTAR July 11, 2022 TAR(1)", "subsections": [] } } } }