usr.bin/unzip/unzip.1

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