source: general/sysutils/unzip.xml@ 6473e74

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY unzip-download-http "http://www.mirrorservice.org/sites/ftp.info-zip.org/pub/infozip/src/unzip552.tar.gz">
  <!ENTITY unzip-download-ftp  "ftp://ftp.info-zip.org/pub/infozip/src/unzip552.tar.gz">
  <!ENTITY unzip-md5sum        "9d23919999d6eac9217d1f41472034a9">
  <!ENTITY unzip-size          "1.1 MB">
  <!ENTITY unzip-buildsize     "7.2 MB">
  <!ENTITY unzip-time          "0.1 SBU">
]>

<sect1 id="unzip" xreflabel="UnZip-&unzip-version;">
  <?dbhtml filename="unzip.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">unzip-&unzip-version;.tar</keyword>
      <keyword role="ftpdir">unzip</keyword>
    </keywordset>
  </sect1info>

  <title>UnZip-&unzip-version;</title>

  <indexterm zone="unzip">
    <primary sortas="a-UnZip">UnZip</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to UnZip</title>

    <para>The <application>UnZip</application> package contains
    <filename>ZIP</filename> extraction utilities. These are useful for
    extracting files from <filename>ZIP</filename> archives.
    <filename>ZIP</filename> archives are created with
    <application>PKZIP</application> or <application>Info-ZIP</application>
    utilities, primarily in a DOS environment.</para>

    <caution>
      <para>The <application>UnZip</application> package has some locale
      related issues. For a full explanation of the issues and some possible
      solutions, see the <xref linkend="locale-unzip"/> section of the
      <xref linkend="locale-issues"/>.</para>
    </caution>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&unzip-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&unzip-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &unzip-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &unzip-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &unzip-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &unzip-time;</para>
      </listitem>
    </itemizedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of UnZip</title>

    <para>Install <application>UnZip</application> by running the following
    commands:</para>

<screen><userinput>make -f unix/Makefile LOCAL_UNZIP=-D_FILE_OFFSET_BITS=64 linux</userinput></screen>

    <para>To test the results, issue: <command>LD_LIBRARY_PATH=$PWD
    make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make prefix=/usr install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>linux</parameter>:
    This target in the <filename>Makefile</filename> makes assumptions
    that are useful for a Linux system when compiling the executables.
    To obtain alternatives to this target, use <command>make list</command></para>

    <para><parameter>LOCAL_UNZIP=...</parameter>:
    This sets the compilation flags to allow <application>UnZip</application>
    to handle files upto 4 GB.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>funzip, unzip, unzipfsx, zipgrep, and zipinfo</seg>
        <seg>libunzip.so</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="funzip">
        <term><command>funzip</command></term>
        <listitem>
          <para>allows the output of <command>unzip</command> commands to be
          redirected.</para>
          <indexterm zone="unzip funzip">
            <primary sortas="b-funzip">funzip</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unzip-prog">
        <term><command>unzip</command></term>
        <listitem>
          <para>lists, tests or extracts files from a <filename>ZIP</filename>
          archive.</para>
          <indexterm zone="unzip unzip-prog">
            <primary sortas="b-unzip">unzip</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unzipfsx">
        <term><command>unzipfsx</command></term>
        <listitem>
          <para>is a self-extracting stub that can be prepended to a
          <filename>ZIP</filename> archive.  Files in this format allow the
          recipient to decompress the archive without installing
          <application>UnZip</application>.</para>
          <indexterm zone="unzip unzipfsx">
            <primary sortas="b-unzipfsx">unzipfsx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="zipgrep">
        <term><command>zipgrep</command></term>
        <listitem>
          <para>searches files in a <filename>ZIP</filename> archive for
          lines matching a pattern.</para>
          <indexterm zone="unzip zipgrep">
            <primary sortas="b-zipgrep">zipgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="zipinfo">
        <term><command>zipinfo</command></term>
        <listitem>
          <para>produces technical information about the files in a
          <filename>ZIP</filename> archive, including file access permissions,
          encryption status, type of compression, etc.</para>
          <indexterm zone="unzip zipinfo">
            <primary sortas="b-zipinfo">zipinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libunzip">
        <term><filename class='libraryfile'>libunzip.so</filename></term>
        <listitem>
          <para>contains the API functions required by the
          <application>UnZip</application> programs.</para>
          <indexterm zone="unzip libunzip">
            <primary sortas="c-libunzip">libunzip.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>