bin/pax/tar.1

   1 .\" $NetBSD: tar.1,v 1.33 2012/03/22 07:58:17 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1996 SigmaSoft, Th. Lockert
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\"     OpenBSD: tar.1,v 1.28 2000/11/09 23:58:56 aaron Exp
  27 .\"
  28 .Dd June 18, 2011
  29 .Dt TAR 1
  30 .Os
  31 .Sh NAME
  32 .Nm tar
  33 .Nd tape archiver
  34 .Sh SYNOPSIS
  35 .Nm tar
  36 .Sm off
  37 .Oo \&- Oc {crtux} Op Fl 014578befHhjklmOoPpqSvwXZz
  38 .Sm on
  39 .Op Ar archive
  40 .Op Ar blocksize
  41 .\" XXX how to do this right?
  42 .Op Fl C Ar directory
  43 .Op Fl s Ar replstr
  44 .Op Fl T Ar file
  45 .Op Ar file ...
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 command creates, adds files to, or extracts files from an
  50 archive file in
  51 .Dq tar
  52 format.
  53 A tar archive is often stored on a magnetic tape, but can be
  54 stored equally well on a floppy, CD-ROM, or in a regular disk file.
  55 .Pp
  56 One of the following flags must be present:
  57 .Bl -tag -width Ar
  58 .It Fl c , Fl Fl create
  59 Create new archive, or overwrite an existing archive,
  60 adding the specified files to it.
  61 .It Fl r , Fl Fl append
  62 Append the named new files to existing archive.
  63 Note that this will only work on media on which an end-of-file mark
  64 can be overwritten.
  65 .It Fl t , Fl Fl list
  66 List contents of archive.
  67 If any files are named on the
  68 command line, only those files will be listed.
  69 .It Fl u , Fl Fl update
  70 Alias for
  71 .Fl r .
  72 .It Fl x , Fl Fl extract , Fl Fl get
  73 Extract files from archive.
  74 If any files are named on the
  75 command line, only those files will be extracted from the
  76 archive.
  77 If more than one copy of a file exists in the
  78 archive, later copies will overwrite earlier copies during
  79 extraction.
  80 The file mode and modification time are preserved
  81 if possible.
  82 The file mode is subject to modification by the
  83 .Xr umask 2 .
  84 .El
  85 .Pp
  86 In addition to the flags mentioned above, any of the following
  87 flags may be used:
  88 .Bl -tag -width Ar
  89 .It Fl b Ar "blocking factor" , Fl Fl block-size Ar "blocking factor"
  90 Set blocking factor to use for the archive.
  91 .Nm
  92 uses 512 byte blocks.
  93 The default is 20, the maximum is 126.
  94 Archives with a blocking factor larger 63 violate the
  95 .Tn POSIX
  96 standard and will not be portable to all systems.
  97 .It Fl e
  98 Stop after first error.
  99 .It Fl f Ar archive , Fl Fl file Ar archive
 100 Filename where the archive is stored.
 101 Defaults to
 102 .Pa /dev/rst0 .
 103 If the archive is of the form:
 104 .Ar [[user@]host:]file
 105 then the archive will be processed using
 106 .Xr rmt 8 .
 107 .It Fl h , Fl Fl dereference
 108 Follow symbolic links as if they were normal files
 109 or directories.
 110 .It Fl j, Fl Fl bzip2, Fl Fl bunzip2
 111 Use
 112 .Xr bzip2 1
 113 for compression of the archive.
 114 This option is a GNU extension.
 115 .It Fl k , Fl Fl keep-old-files
 116 Keep existing files; don't overwrite them from archive.
 117 .It Fl l , Fl Fl one-file-system
 118 Do not descend across mount points.
 119 .\" should be '-X'
 120 .It Fl m , Fl Fl modification-time
 121 Do not preserve modification time.
 122 .It Fl O
 123 When creating and appending to an archive, write old-style (non-POSIX) archives.
 124 When extracting from an archive, extract to standard output.
 125 .It Fl o , Fl Fl portability , Fl Fl old-archive
 126 Don't write directory information that the older (V7) style
 127 .Nm
 128 is unable to decode.
 129 This implies the
 130 .Fl O
 131 flag.
 132 .It Fl p , Fl Fl preserve-permissions , Fl Fl preserve
 133 Preserve user and group ID as well as file mode regardless of
 134 the current
 135 .Xr umask 2 .
 136 The setuid and setgid bits are only preserved if the user is
 137 the superuser.
 138 Only meaningful in conjunction with the
 139 .Fl x
 140 flag.
 141 .It Fl q , Fl Fl fast-read
 142 Select the first archive member that matches each
 143 .Ar pattern
 144 operand.
 145 No more than one archive member is matched for each
 146 .Ar pattern .
 147 When members of type directory are matched, the file hierarchy rooted at that
 148 directory is also matched.
 149 .It Fl S , Fl Fl sparse
 150 This flag has no effect as
 151 .Nm
 152 always generates sparse files.
 153 .It Fl s Ar replstr
 154 Modify the file or archive member names specified by the
 155 .Ar pattern
 156 or
 157 .Ar file
 158 operands according to the substitution expression
 159 .Ar replstr ,
 160 using the syntax of the
 161 .Xr ed 1
 162 utility regular expressions.
 163 The format of these regular expressions are:
 164 .Dl /old/new/[gps]
 165 As in
 166 .Xr ed 1 ,
 167 .Cm old
 168 is a basic regular expression and
 169 .Cm new
 170 can contain an ampersand (\*[Am]), \en (where n is a digit) back-references,
 171 or subexpression matching.
 172 The
 173 .Cm old
 174 string may also contain
 175 .Aq Dv newline
 176 characters.
 177 Any non-null character can be used as a delimiter (/ is shown here).
 178 Multiple
 179 .Fl s
 180 expressions can be specified.
 181 The expressions are applied in the order they are specified on the
 182 command line, terminating with the first successful substitution.
 183 The optional trailing
 184 .Cm g
 185 continues to apply the substitution expression to the pathname substring
 186 which starts with the first character following the end of the last successful
 187 substitution.
 188 The first unsuccessful substitution stops the operation of the
 189 .Cm g
 190 option.
 191 The optional trailing
 192 .Cm p
 193 will cause the final result of a successful substitution to be written to
 194 .Dv standard error
 195 in the following format:
 196 .Dl \*[Lt]original pathname\*[Gt] \*[Gt]\*[Gt] \*[Lt]new pathname\*[Gt]
 197 File or archive member names that substitute to the empty string
 198 are not selected and will be skipped.
 199 The substitutions are applied by default to the destination hard and symbolic
 200 links.
 201 The optional trailing
 202 .Cm s
 203 prevents the substitutions from being performed on symbolic link destinations.
 204 .It Fl v
 205 Verbose operation mode.
 206 .It Fl w , Fl Fl interactive , Fl Fl confirmation
 207 Interactively rename files.
 208 This option causes
 209 .Nm
 210 to prompt the user for the filename to use when storing or
 211 extracting files in an archive.
 212 .It Fl Fl xz
 213 Compress/decompress archive using
 214 .Xr xz 1 .
 215 .It Fl z , Fl Fl gzip , Fl Fl gunzip
 216 Compress/decompress archive using
 217 .Xr gzip 1 .
 218 .It Fl B , Fl Fl read-full-blocks
 219 Reassemble small reads into full blocks (For reading from 4.2BSD pipes).
 220 .It Fl C Ar directory , Fl Fl directory Ar directory
 221 This is a positional argument which sets the working directory for the
 222 following files.
 223 When extracting, files will be extracted into
 224 the specified directory; when creating, the specified files will be matched
 225 from the directory.
 226 This argument and its parameter may also appear in a file list specified by
 227 .Fl T .
 228 .It Fl H
 229 Only follow symlinks given on command line.
 230 .Pp
 231 Note SysVr3/i386 picked up ISC/SCO UNIX compatibility which implemented
 232 .Dq Fl F Ar file
 233 which was defined as obtaining a list of command line switches and files
 234 on which to operate from the specified file,
 235 but SunOS-5 uses
 236 .Dq Fl I Ar file
 237 because they use
 238 .Sq Fl F
 239 to mean something else.
 240 We might someday provide SunOS-5 compatibility
 241 but it makes little sense to confuse things with ISC/SCO compatibility.
 242 .\".It Fl L
 243 .\"Do not follow any symlinks (do the opposite of
 244 .\".Fl h ).
 245 .It Fl P , Fl Fl absolute-paths
 246 Do not strip leading slashes
 247 .Pq Sq /
 248 from pathnames.
 249 The default is to strip leading slashes.
 250 .It Fl T Ar file , Fl Fl files-from Ar file
 251 Read the names of files to archive or extract from the given file, one
 252 per line.
 253 A line may also specify the positional argument
 254 .Dq Fl C Ar directory .
 255 .It Fl X Ar file , Fl Fl exclude-from Ar file
 256 Exclude files matching the shell glob patterns listed in the given file.
 257 .\" exclude should be '-E' and '-X' should be one-file-system
 258 .Pp
 259 Note that it would be more standard to use this option to mean ``do not
 260 cross filesystem mount points.''
 261 .It Fl Z , Fl Fl compress , Fl Fl uncompress
 262 Compress archive using compress.
 263 .It Fl Fl strict
 264 Do not enable GNU tar extensions such as long filenames and long link names.
 265 .It Fl Fl atime-preserve
 266 Preserve file access times.
 267 .It Fl Fl chroot
 268 .Fn chroot
 269 to the current directory before extracting files.
 270 Use with
 271 .Fl x
 272 and
 273 .Fl h
 274 to make absolute symlinks relative to the current directory.
 275 .It Fl Fl unlink
 276 Ignored, only accepted for compatibility with other
 277 .Nm
 278 implementations.
 279 .Nm
 280 always unlinks files before creating them.
 281 .It Fl Fl use-compress-program Ar program
 282 Use the named program as the program to decompress the input.
 283 .It Fl Fl force-local
 284 Do not interpret filenames that contain a
 285 .Sq \&:
 286 as remote files.
 287 .It Fl Fl insecure
 288 Normally
 289 .Nm
 290 ignores filenames that contain
 291 .Dq ..
 292 as a path component.
 293 With this option, files that contain
 294 .Dq ..
 295 can be processed.
 296 .It Fl Fl no-recursion
 297 Cause files of type directory being copied or archived, or archive members of
 298 type directory being extracted, to match only the directory file or archive
 299 member and not the file hierarchy rooted at the directory.
 300 .El
 301 .Pp
 302 The options
 303 .Op Fl 014578
 304 can be used to select one of the compiled-in backup devices,
 305 .Pa /dev/rstN .
 306 .Sh FILES
 307 .Bl -tag -width "/dev/rst0"
 308 .It Pa /dev/rst0
 309 default archive name
 310 .El
 311 .Sh DIAGNOSTICS
 312 .Nm
 313 will exit with one of the following values:
 314 .Bl -tag -width 2n
 315 .It 0
 316 All files were processed successfully.
 317 .It 1
 318 An error occurred.
 319 .El
 320 .Pp
 321 Whenever
 322 .Nm
 323 cannot create a file or a link when extracting an archive or cannot
 324 find a file while writing an archive, or cannot preserve the user
 325 ID, group ID, file mode, or access and modification times when the
 326 .Fl p
 327 option is specified, a diagnostic message is written to standard
 328 error and a non-zero exit value will be returned, but processing
 329 will continue.
 330 In the case where
 331 .Nm
 332 cannot create a link to a file,
 333 .Nm
 334 will not create a second copy of the file.
 335 .Pp
 336 If the extraction of a file from an archive is prematurely terminated
 337 by a signal or error,
 338 .Nm
 339 may have only partially extracted the file the user wanted.
 340 Additionally, the file modes of extracted files and directories may
 341 have incorrect file bits, and the modification and access times may
 342 be wrong.
 343 .Pp
 344 If the creation of an archive is prematurely terminated by a signal
 345 or error,
 346 .Nm
 347 may have only partially created the archive which may violate the
 348 specific archive format specification.
 349 .Sh SEE ALSO
 350 .Xr cpio 1 ,
 351 .Xr pax 1
 352 .Sh HISTORY
 353 A
 354 .Nm
 355 command first appeared in
 356 .At v7 .
 357 .Sh AUTHORS
 358 Keith Muller at the University of California, San Diego.