path: root/archivers/gtar-base/files/gtar.1

.\"
.\" $NetBSD: gtar.1,v 1.4 2004/09/27 16:12:04 wiz Exp $
.\" @(#)tar.1 1.13.25 2000/12/14 Werner;
.\" from SuSe tar-1.13.25-45.src.rpm
.TH TAR 1 "14 December 2000" "Version 1.13.25"
.UC 1
.SH NAME
tar \- The GNU version of the tar archiving utility
.SH SYNOPSIS
.B tar
.RB [ \- ]
.RB [ "A \-\-catenate \-\-concatenate" \||\| "c \-\-create" \||\| "d \-\-diff \-\-compare" \||\| "r \-\-append" \||\| "t \-\-list" \||\| "u \-\-update" \||\| "x \-\-extract \-\-get" ]
.RB [ \-\-atime\-preserve ]
.RB [ "\-b, \-\-block\-size=\fIN\fP" ]
.RB [ "\-B, \-\-read\-full\-blocks" ]
.RB [ "\-C, \-\-directory=\fIDIR\fP" ]
.RB [ \-\-checkpoint ]
.RB [ "\-f, \-\-file=\fR[\fP\fIHOSTNAME\fP:\fR]\fP\fIF\fP" ]
.RB [ "\-F, \-\-info\-script=\fIF\fP, \-\-new\-volume\-script=\fIF\fP" ]
.RB [ "\-\-force\-local" ]
.RB [ "\-G, \-\-incremental" ]
.RB [ "\-g, \-\-listed\-incremental=\fIF\fP" ]
.RB [ "\-h, \-\-dereference" ]
.RB [ "\-i, \-\-ignore\-zeros" ]
.RB [ "\-j, \-\-bzip2, \-\-bunzip2" ]
.RB [ \-\-ignore\-failed\-read ]
.RB [ "\-k, \-\-keep\-old\-files" ]
.RB [ "\-K, \-\-starting\-file=\fIF\fP" ]
.RB [ "\-l, \-\-one\-file\-system" ]
.RB [ "\-L, \-\-tape\-length=\fIN\fP" ]
.RB [ "\-m, \-\-modification\-time" ]
.RB [ "\-M, \-\-multi\-volume" ]
.RB [ "\-N, \-\-after\-date=\fIDATE\fP, \-\-newer=\fIDATE\fP" ]
.RB [ "\-o, \-\-old\-archive, \-\-portability" ]
.RB [ "\-O, \-\-to\-stdout" ]
.RB [ "\-p, \-\-same\-permissions, \-\-preserve\-permissions" ]
.RB [ "\-P, \-\-absolute\-paths" ]
.RB [ \-\-preserve ]
.RB [ "\-R, \-\-record\-number" ]
.RB [ "\-\-recursive\-unlink" ]
.RB [ \-\-remove\-files ]
.RB [ "\-s, \-\-same\-order, \-\-preserve\-order" ]
.RB [ \-\-same\-owner ]
.RB [ "\-S, \-\-sparse" ]
.RB [ "\-T, \-\-files\-from=\fIF\fP" ]
.RB [ \-\-null ]
.RB [ \-\-totals ]
.RB [ "\-v, \-\-verbose" ]
.RB [ "\-V, \-\-label=\fINAME\fP" ]
.RB [ \-\-version ]
.RB [ "\-w, \-\-interactive, \-\-confirmation" ]
.RB [ "\-W, \-\-verify" ]
.RB [ "\-\-exclude=\fIFILE\fP" ]
.RB [ "\-X, \-\-exclude\-from=\fIFILE\fP" ]
.RB [ "\-Z, \-\-compress, \-\-uncompress" ]
.RB [ "\-z, \-\-gzip, \-\-ungzip" ]
.RB [ "\-\-use\-compress\-program=\fIPROG\fP" ]
.RB [ \-\-block\-compress ]
.RB [ \-\fR[\fP0\-7\fR][\fPlmh\fR]\fP ]
.TP
.I filename1 \fR[\fP filename2\fR,\fP \fR...\fP filenameN \fR]
.TP
.I directory1 \fR[\fP directory2\fR,\fP \fR...\fP directoryN \fR]
.SH DESCRIPTION
.LP
This manual page documents the GNU version 1.13.25 of
.BR tar ,
an archiving program designed to store and extract files from
an archive file known as a
.IR tarfile .
A
.I tarfile
may be made on a tape drive, however, it is also common
to write a
.I tarfile
to a normal file.
The first argument to
.B tar
must be one of the options:
.BR Acdrtux ,
followed by any optional functions.
The final arguments to
.B tar
are the names of the files or directories which should be archived. The use
of a directory name always implies that the subdirectories below should be
included in the archive.
.SH "FUNCTION LETTERS"
.TP
.B One of the following options must be used:
.TP
.B \-A, \-\-catenate, \-\-concatenate
append tar files to an archive
.TP
.B \-c, \-\-create
create a new archive
.TP
.B \-d, \-\-diff, \-\-compare
find differences between archive and file system
.TP
.B \-\-delete
delete from the archive (not for use on mag tapes!)
.TP
.B \-r, \-\-append
append files to the end of an archive
.TP
.B \-t, \-\-list
list the contents of an archive
.TP
.B \-u, \-\-update
only append files that are newer than copy in archive
.TP
.B \-x, \-\-extract, \-\-get
extract files from an archive
.SH "OTHER OPTIONS"
.TP
.B \-\-atime\-preserve
don't change access times on dumped files
.TP
.B \-b, \-\-block\-size=\fIN
block size of \fIN\fPx512 bytes (default \fIN\fP=20)
.TP
.B \-B, \-\-read\-full\-blocks
reblock as we read (for reading 4.2BSD pipes)
.TP
.B \-C, \-\-directory=\fIDIR
change to directory \fIDIR
.TP
.B \-\-checkpoint
print directory names while reading the archive
.TP
.B \-f, \-\-file=\fR[\fP\fIHOSTNAME\fP:\fR]\fP\fIF
use archive file or device \fIF\fP (default /dev/rmt0)
.TP
.B \-\-force\-local
archive file is local even if has a colon
.TP
.B \-F, \-\-info\-script=\fIF\fP, \-\-new\-volume\-script=\fIF
run script at end of each tape (implies \-M)
.TP
.B \-G, \-\-incremental
create/list/extract old GNU\-format incremental backup
.TP
.B \-g, \-\-listed\-incremental=\fIF
create/list/extract new GNU\-format incremental backup
.TP
.B \-h, \-\-dereference
don't dump symlinks; dump the files they point to
.TP
.B \-i, \-\-ignore\-zeros
ignore blocks of zeros in archive (normally mean EOF)
.TP
.B \-j, \-\-bzip2, \-\-bunzip2
filter the archive through bzip2
.TP
.B \-\-ignore\-failed\-read
don't exit with non\-zero status on unreadable files
.TP
.B \-k, \-\-keep\-old\-files
keep existing files; don't overwrite them from archive
.TP
.B \-K, \-\-starting\-file=\fIF
begin at file F in the archive
.TP
.B \-l, \-\-one\-file\-system
stay in local file system when creating an archive
.TP
.B \-L, \-\-tape\-length=\fIN
change tapes after writing N*1024 bytes
.TP
.B \-m, \-\-modification\-time
don't extract file modified time
.TP
.B \-M, \-\-multi\-volume
create/list/extract multi\-volume archive
.TP
.B \-N, \-\-after\-date=\fIDATE\fP, \-\-newer=\fIDATE
only store files newer than \fIDATE
.TP
.B \-o, \-\-old\-archive, \-\-portability
write a V7 format archive, rather than ANSI format
.TP
.B \-O, \-\-to\-stdout
extract files to standard output
.TP
.B \-p, \-\-same\-permissions, \-\-preserve\-permissions
extract all protection information
.TP
.B \-P, \-\-absolute\-paths
don't strip leading `/'s from file names
.TP
.B \-\-preserve
like \-p \-s
.TP
.B \-R, \-\-record\-number
show record number within archive with each message
.TP
.B \-\-recursive\-unlink
Empty hierarchies prior to extracting directory
.TP
.B \-\-remove\-files
remove files after adding them to the archive
.TP
.B \-s, \-\-same\-order, \-\-preserve\-order
list of names to extract is sorted to match archive
.TP
.B \-\-same\-owner
create extracted files with the same ownership
.TP
.B \-S, \-\-sparse
handle sparse files efficiently
.TP
.B \-T, \-\-files\-from=\fIF
get names to extract or create from file \fIF
.TP
.B \-\-null
-T reads null\-terminated names, disable \-C
.TP
.B \-\-totals
print total bytes written with \-\-create
.TP
.B \-v, \-\-verbose
verbosely list files processed
.TP
.B \-V, \-\-label=\fINAME
create archive with volume name \fINAME
.TP
.B \-\-version
print tar program version number
.TP
.B \-w, \-\-interactive, \-\-confirmation
ask for confirmation for every action
.TP
.B \-W, \-\-verify
attempt to verify the archive after writing it
.TP
.B \-\-exclude=\fIFILE
exclude file \fIFILE
.TP
.B \-X, \-\-exclude\-from=\fIFILE
exclude files listed in \fIFILE
.TP
.B \-Z, \-\-compress, \-\-uncompress      
filter the archive through compress
.TP
.B \-z, \-\-gzip, \-\-ungzip
filter the archive through gzip
.TP
.B \-\-use\-compress\-program=\fIPROG
filter the archive through \fIPROG\fP (which must accept \-d)
.TP
.B \-\-block\-compress
block the output of compression program for tapes
.TP
.B \-\fR[\fP0\-7\fR][\fPlmh\fR]
specify drive and density
.SH BUGS
.LP
The GNU folks, in general, abhor man pages, and create info documents instead.
The maintainer of tar falls into this category.  This man page is neither
complete, nor current, and was included in the Debian Linux packaging of tar
entirely to reduce the frequency with which the lack of a man page gets
reported as a bug in our defect tracking system.

If you really want to understand tar, then you should run info and read the
tar info pages, or use the info mode in emacs.