git.gag.com Git - debian/pax/blob - tar.1

   1 .\"
   2 .\" Copyright (c) 1996 SigmaSoft, Th. Lockert
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"      This product includes software developed by SigmaSoft, Th. Lockert.
  16 .\" 4. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\"     $OpenBSD: tar.1,v 1.17 1998/09/23 00:13:49 aaron Exp $
  31 .\"
  32 .Dd June 11, 1996
  33 .Dt TAR 1
  34 .Os
  35 .Sh NAME
  36 .Nm tar
  37 .Nd tape archiver
  38 .Sh SYNOPSIS
  39 .Nm
  40 .No [-]{crtux}[befhmopvwzHLPXZ014578]
  41 .Op Ar archive
  42 .Op Ar blocksize
  43 .\" XXX how to do this right?
  44 .No [-C
  45 .Ar directory
  46 .No ]
  47 .No [-s
  48 .Ar replstr
  49 .No ]
  50 .Ar file1
  51 .Op Ar file2 ...
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 command creates, adds files to, or extracts files from an
  56 archive file in \*Qtar\*U format.  A tar archive is often
  57 stored on a magnetic tape, but can be a floppy or a regular
  58 disk file.
  59 .Pp
  60 One of the following flags must be present:
  61 .Bl -tag -width Ar
  62 .It Fl c
  63 Create new archive, or overwrite an existing archive,
  64 adding the specified files to it.
  65 .It Fl r
  66 Append the named new files to existing archive.  Note that
  67 this will only work on media on which an end-of-file mark
  68 can be overwritten.
  69 .It Fl t
  70 List contents of archive.  If any files are named on the
  71 command line, only those files will be listed.
  72 .It Fl u
  73 Alias for
  74 .Fl r .
  75 .It Fl x
  76 Extract files from archive.  If any files are named on the
  77 command line, only those files will be extracted from the
  78 archive.  If more than one copy of a file exists in the
  79 archive, later copies will overwrite earlier copies during
  80 extraction.  The file mode and modification time are preserved
  81 if possible.  The file mode is subject to modification by the
  82 .Xr umask 2 .
  83 .El
  84 .Pp
  85 In addition to the flags mentioned above, any of the following
  86 flags may be used:
  87 .Bl -tag -width Ar
  88 .It Fl b Ar "blocking factor"
  89 Set blocking factor to use for the archive.
  90 .Nm
  91 uses 512 byte blocks.  The default is 20, the maximum is 126.
  92 Archives with a blocking factor larger 63 violate the
  93 .Tn POSIX
  94 standard and will not be portable to all systems.
  95 .It Fl e
  96 Stop after first error.
  97 .It Fl f Ar archive
  98 Filename where the archive is stored.  Defaults to
  99 .Pa /dev/rst0 .
 100 .It Fl h
 101 Follow symbolic links as if they were normal files
 102 or directories.
 103 .It Fl m
 104 Do not preserve modification time.
 105 .It Fl O
 106 Write old-style (non-POSIX) archives.
 107 .It Fl o
 108 Don't write directory information that the older (V7) style
 109 .Nm
 110 is unable to decode.
 111 This implies the
 112 .Fl O
 113 flag.
 114 .It Fl p
 115 Preserve user and group ID as well as file mode regardless of
 116 the current
 117 .Xr umask 2 .
 118 The setuid and setgid bits are only preserved if the user is
 119 the superuser.  Only meaningful in conjunction with the
 120 .Fl x
 121 flag.
 122 .It Fl s Ar replstr
 123 Modify the file or archive member names specified by the
 124 .Ar pattern
 125 or
 126 .Ar file
 127 operands according to the substitution expression
 128 .Ar replstr ,
 129 using the syntax of the
 130 .Xr ed 1
 131 utility regular expressions.
 132 The format of these regular expressions are:
 133 .Dl /old/new/[gp]
 134 As in
 135 .Xr ed 1 ,
 136 .Cm old
 137 is a basic regular expression and
 138 .Cm new
 139 can contain an ampersand (&), \\n (where n is a digit) back-references,
 140 or subexpression matching.
 141 The
 142 .Cm old
 143 string may also contain
 144 .Dv <newline>
 145 characters.
 146 Any non-null character can be used as a delimiter (/ is shown here).
 147 Multiple
 148 .Fl s
 149 expressions can be specified.
 150 The expressions are applied in the order they are specified on the
 151 command line, terminating with the first successful substitution.
 152 The optional trailing
 153 .Cm g
 154 continues to apply the substitution expression to the pathname substring
 155 which starts with the first character following the end of the last successful
 156 substitution. The first unsuccessful substitution stops the operation of the
 157 .Cm g
 158 option.
 159 The optional trailing
 160 .Cm p
 161 will cause the final result of a successful substitution to be written to
 162 .Dv standard error
 163 in the following format:
 164 .Dl <original pathname> >> <new pathname>
 165 File or archive member names that substitute to the empty string
 166 are not selected and will be skipped.
 167 .It Fl v
 168 Verbose operation mode.
 169 .It Fl w
 170 Interactively rename files.  This option causes
 171 .Nm
 172 to prompt the user for the filename to use when storing or
 173 extracting files in an archive.
 174 .It Fl z
 175 Compress archive using gzip.
 176 .It Fl C Ar directory
 177 This is a positional argument which sets the working directory for the
 178 following files.  When extracting, files will be extracted into
 179 the specified directory; when creating, the specified files will be matched
 180 from the directory.
 181 .It Fl H
 182 Follow symlinks given on command line only.
 183 .It Fl L
 184 Follow all symlinks.
 185 .It Fl P
 186 Do not strip leading slashes (``/'') from pathnames.
 187 The default is to strip leading slashes.
 188 .It Fl X
 189 Do not cross mount points in the file system.
 190 .It Fl Z
 191 Compress archive using compress.
 192 .El
 193 .Pp
 194 The options
 195 .Op Fl 014578
 196 can be used to select one of the compiled-in backup devices,
 197 .Pa /dev/rstN .
 198 .Sh FILES
 199 .Bl -tag -width "/dev/rst0"
 200 .It Pa /dev/rst0
 201 default archive name
 202 .El
 203 .Sh SEE ALSO
 204 .Xr cpio 1 ,
 205 .Xr pax 1
 206 .Sh AUTHOR
 207 Keith Muller at the University of California, San Diego.
 208 .Sh ERRORS
 209 .Nm
 210 will exit with one of the following values:
 211 .Bl -tag -width 2n
 212 .It 0
 213 All files were processed successfully.
 214 .It 1
 215 An error occurred.
 216 .El
 217 .Pp
 218 Whenever
 219 .Nm
 220 cannot create a file or a link when extracting an archive or cannot
 221 find a file while writing an archive, or cannot preserve the user
 222 ID, group ID, file mode or access and modification times when the
 223 .Fl p
 224 option is specified, a diagnostic message is written to standard
 225 error and a non-zero exit value will be returned, but processing
 226 will continue.  In the case where
 227 .Nm
 228 cannot create a link to a file,
 229 .Nm
 230 will not create a second copy of the file.
 231 .Pp
 232 If the extraction of a file from an archive is prematurely terminated
 233 by a signal or error,
 234 .Nm
 235 may have only partially extracted the file the user wanted.
 236 Additionally, the file modes of extracted files and directories may
 237 have incorrect file bits, and the modification and access times may
 238 be wrong.
 239 .Pp
 240 If the creation of an archive is prematurely terminated by a signal
 241 or error,
 242 .Nm
 243 may have only partially created the archive which may violate the
 244 specific archive format specification.