usr.bin/unzip/unzip.1

   1 .\"-
   2 .\" Copyright (c) 2009 Joerg Sonnenberger <joerg@NetBSD.org>
   3 .\" Copyright (c) 2007-2008 Dag-Erling Coïdan Smørgrav
   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 AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: revision 180125$
  28 .\" $NetBSD: unzip.1,v 1.6 2009/08/24 08:38:39 joerg Exp $
  29 .\"
  30 .Dd September 6, 2009
  31 .Dt UNZIP 1
  32 .Os
  33 .Sh NAME
  34 .Nm unzip
  35 .Nd extract files from a ZIP archive
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl aCcfjLlnopqtuv
  39 .Op Fl d Ar dir
  40 .Op Fl x Ar pattern
  41 .Ar zipfile
  42 .Sh DESCRIPTION
  43 The following options are available:
  44 .Bl -tag -width Fl
  45 .It Fl a
  46 When extracting a text file, convert DOS-style line endings to
  47 Unix-style line endings.
  48 .It Fl C
  49 Match file names case-insensitively.
  50 .It Fl c
  51 Extract to stdout/screen.
  52 When extracting files from the zipfile, they are written to stdout.
  53 This is similar to
  54 .Fl p ,
  55 but doesn't suppress normal output.
  56 .It Fl d Ar dir
  57 Extract files into the specified directory rather than the current
  58 directory.
  59 .It Fl f
  60 Update existing.
  61 Extract only files from the zipfile if a file with the same name
  62 already exists on disk and is older than the former.
  63 Otherwise, the file is silently skipped.
  64 .It Fl j
  65 Ignore directories stored in the zipfile; instead, extract all files
  66 directly into the extraction directory.
  67 .It Fl L
  68 Convert the names of the extracted files and directories to lowercase.
  69 .It Fl l
  70 List, rather than extract, the contents of the zipfile.
  71 .It Fl n
  72 No overwrite.
  73 When extracting a file from the zipfile, if a file with the same name
  74 already exists on disk, the file is silently skipped.
  75 .It Fl o
  76 Overwrite.
  77 When extracting a file from the zipfile, if a file with the same name
  78 already exists on disk, the existing file is replaced with the file
  79 from the zipfile.
  80 .It Fl p
  81 Extract to stdout.
  82 When extracting files from the zipfile, they are written to stdout.
  83 The normal output is suppressed as if
  84 .Fl q
  85 was specified.
  86 .It Fl q
  87 Quiet: print less information while extracting.
  88 .It Fl t
  89 Test: do not extract anything, but verify the checksum of every file
  90 in the archive.
  91 .It Fl u
  92 Update.
  93 When extracting a file from the zipfile, if a file with the same name
  94 already exists on disk, the existing file is replaced with the file
  95 from the zipfile if and only if the latter is newer than the former.
  96 Otherwise, the file is silently skipped.
  97 .It Fl v
  98 List verbosely, rather than extract, the contents of the zipfile.
  99 This differs from
 100 .Fl l
 101 by using the long listing.
 102 Note that most of the data is currently fake and does not reflect the
 103 content of the archive.
 104 .It Fl x Ar pattern
 105 Exclude files matching the pattern
 106 .Ar pattern .
 107 .El
 108 .Pp
 109 Note that only one of
 110 .Fl n ,
 111 .Fl o ,
 112 and
 113 .Fl u
 114 may be specified.
 115 .Sh ENVIRONMENT
 116 If the
 117 .Ev UNZIP_DEBUG
 118 environment variable is defined, the
 119 .Fl q
 120 command-line option has no effect, and additional debugging
 121 information will be printed to
 122 .Va stderr .
 123 .Sh COMPATIBILITY
 124 The
 125 .Nm
 126 utility aims to be sufficiently compatible with other implementations
 127 to serve as a drop-in replacement in the context of the
 128 .Xr pkgsrc 7
 129 system.
 130 No attempt has been made to replicate functionality which is not
 131 required for that purpose.
 132 .Pp
 133 For compatibility reasons, command-line options will be recognized if
 134 they are listed not only before but also after the name of the
 135 zipfile.
 136 .Pp
 137 Normally, the
 138 .Fl a
 139 option should only affect files which are marked as text files in the
 140 zipfile's central directory.
 141 Since the
 142 .Xr archive 3
 143 library reads zipfiles sequentially, and does not use the central
 144 directory, that information is not available to the
 145 .Nm
 146 utility.
 147 Instead, the
 148 .Nm
 149 utility will assume that a file is a text file if no non-ASCII
 150 characters are present within the first block of data decompressed for
 151 that file.
 152 If non-ASCII characters appear in subsequent blocks of data, a warning
 153 will be issued.
 154 .Pp
 155 The
 156 .Nm
 157 utility is only able to process ZIP archives handled by
 158 .Xr libarchive 3 .
 159 Depending on the installed version of
 160 .Xr libarchive 3 ,
 161 this may or may not include self-extracting archives.
 162 .Sh SEE ALSO
 163 .Xr libarchive 3
 164 .Sh HISTORY
 165 The
 166 .Nm
 167 utility appeared in
 168 .Nx 6.0 .
 169 .Sh AUTHORS
 170 The
 171 .Nm
 172 utility and this manual page were written by
 173 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
 174 It uses the
 175 .Xr archive 3
 176 library developed by
 177 .An Tim Kientzle Aq kientzle@FreeBSD.org .
 178 .Sh BUGS
 179 The
 180 .Nm
 181 utility currently does not support asking the user whether to
 182 overwrite or skip a file that already exists on disk.
 183 To be on the safe side, it will fail if it encounters a file that
 184 already exists and neither the
 185 .Fl n
 186 nor the
 187 .Fl o
 188 command line option was specified.