view release on metacpan or  search on metacpan

unzip-6.0/INSTALL  view on Meta::CPAN

      USE_DJGPP_GLOB  (MS-DOS DJGPP 2.0x only)
        If you like to get UnZip binaries that handle command line arguments
        similar to Unix tools which are run in an Unix shell, you might want
        to set this compilation option.  This option enables the support for
        globbing command line arguments containing wildcards that is built
        into the DJGPP startup code.  When using a binary compiled with this
        option, you may have to enclose wildcard arguments in double quotes
        to get them passed to the program unmodified.  Enabling this option
        is not recommended, because it results in Info-Zip binaries that do
        not behave as expected for MS-DOS programs.

      USE_VFAT  (MS-DOS only, for using same executable under DOS and Win95/NT)
        djgpp 2.x and emx/gcc+RSX 5.1 can detect when they are running under a
        Win32 DOS box and will accordingly enable long-filename support.  For
        now only djgpp 2.x and emx/gcc with RSX 5.1 or later have this feature
        (and it is defined by default in msdos/makefile.dj2 and makefile.emx),
        but if/when other compilers build in similar support, define this
        macro to enable its use.  See also msdos/doscfg.h.  [Note that djgpp
        2.0's LFN support is flaky; users should upgrade to 2.01 or later.]

      NO_W32TIMES_IZFIX (Win32 including WinDLL, and WinCE)
        By specifying this option, you can disable Info-ZIP's special timestamp
        adjustment to get stable time stamps on NTFS disks that do not change
        depending on the current time being normal vs. daylight saving time.
        When this option is set, UnZip behaves exactly like other programs;
        file timestamps on NTFS partitions are created so that their >current<
        local time representation displayed by directory listings (cmd.exe
        "dir" command or Windows Explorer listings) is the same as shown by
        UnZip's listing. But the actual UTC timestamp values stored in the
        NTFS file attributes vary depending on whether extraction is done
        at summer or winter time.
        This option is not recommended because it sacrifies the timestamp
        comparison checks when extracting or modifying archives in "update
        only newer" mode.
        However, for environments where consistency of >displayed< dates
        of files extracted to NTFS vs. FAT disks is considered more important
        than correctly working update/freshen tasks of Zip&UnZip, this
        option may be used.
        >> DO NOT DISTRIBUTE OR PUBLISH executables that were compiled with
        this option! <<

      NOTIMESTAMP
        This option disables the -T option, which basically does exactly what
        Zip's -go options do (i.e., set the timestamp of the zipfile to that of
        the newest file in the archive without rewriting the archive).  Unlike
        Zip, however, UnZip supports wildcard specifications for the archive
        name; for example, "unzip -T *.zip" will set the dates of all zipfiles
        in the current directory.  (UnZip's option is also much faster.)

      DATE_FORMAT=DF_DMY or DF_MDY or DF_YMD
        This option controls the order in which date components are printed
        in non-ZipInfo-mode listings:  day-month-year or month-day-year or
        year-month-day.
        For DOS, FlexOS, OS2, Theos and Win32, the format is automatically
        obtained from the operating system; most others default to DF_MDY.

      DATE_SEPCHAR='-' or '.' or '/' etc.
        This option controls the character that separates the date components
        shown in (non-ZipInfo-mode) listings.  The Win32 port obtains the
        separator automatically from the operating system's locale settings;
        all others default to '-'.

      ACORN_FTYPE_NFS  (needs support for long filenames with embedded commas)
        This option enables a -F option that instructs UnZip to interpret the
        filetype information extracted from Acorn RiscOS extra field blocks.
        The filetype IDs are translated into "NFS filetype extensions" and
        appended to the names of the extracted files. This feature facilitates
        maintenance of Unix-based NFS volumes that are exported to Acorn RiscOS
        systems.

      QLZIP  (Unix only)
        Add some support for QDOS extra fields. This option enables Unix
        UnZip to append "datalen info" to QDOS exec type files in the same
        format as used by QDOS cross-compilers on Unix or the qltools v2.2(+).

      UNIXBACKUP   (default on OS/2, Unix, Win32)
        This option enables a -B option that instructs UnZip to rename files
        that would normally be overwritten.  The renamed files are given a
        tilde suffix and a unique sequence number (`~#####').  Note that
        previously renamed files may be overwritten without notice, even
        if the -n option is given.
        On target ports where UNIXBACKUP is enabled by default, the negated
        option NO_UNIXBACKUP may be used to disable this feature.

      OS2_EAS
        List the sizes of OS/2 EAs and ACLs for each file as two extra columns
        in "unzip -l" output.  This is primarily useful for OS/2 systems, but
        because zipfiles are portable, OS2_EAS can be defined for any system.
        (May be extended someday to show sizes of Mac resource forks, RISCOS
        and VMS file info, etc.)

      DELETE_IF_FULL  (anybody with unlink() function)
        If a write error is encountered (most likely due to a full disk),
        enabling this option will cause the incomplete file to be deleted
        instead of closed normally.  This is particularly useful for the
        Windows CE port, which must generally contend with extremely limited
        resources.

      ASM_CRC   (Amiga/Aztec C; many x86 systems:  DOS, OS/2, Win32, Unix)
        Use an assembler routine to calculate the CRC for each file (speed).

      ASM_INFLATECODES   (Amiga/Aztec C only, for now)
        Use an assembler version of inflate_codes() for speed.

      OLD_EXDIR
        No longer supported.

      SFX_EXDIR
        Enable the "-d <extract_dir>" option for UnZipSFX.  This is now
        enabled by default (since UnZip 5.5) to facilitate use with
        automated installation scripts and the like.  For disabling
        this feature, see the NO_SFX_EXDIR option.

      NO_SFX_EXDIR
        Disables the "-d <extract_dir>" option for UnZipSFX to generate the
        smallest possible executable stub.  (Prior to the UnZip 5.5 release,
        this was the default.)

      CHEAP_SFX_AUTORUN
        Enable a simple "run command after extraction" feature for

unzip-6.0/INSTALL  view on Meta::CPAN

        introduced to allow integration of experimental code for multi-volume
        support in the master source tree. This feature will become a default
        option in the future 6.1 release of UnZip.

      LZW_CLEAN
      USE_UNSHRINK (now default, as of January 2005)
        The "shrinking" algorithm from PKZIP 1.0 is an LZW variant.  Unisys
        patented the Lempel-Ziv-Welch algorithm in 1985 and has publicly
        claimed that decompression is covered by it.  (IBM also patented the
        same thing in a filing 3 weeks prior to Unisys's.)  In 2004, the
        Unisys and IBM patents expired worldwide, so unshrinking is now
        enabled again by default.  If you do not wish to include the LZW
        method, you may still disable it by defining LZW_CLEAN.
        (Unshrinking was used by PKZIP 1.0 and 1.1, and Zip 1.0 and 1.1.
        All newer archives use only the deflation method.)

      COPYRIGHT_CLEAN   (now default)
      USE_SMITH_CODE
        The last chunk of code in UnZip that was blatantly derived from Sam
        Smith's unzip 2.0 (as in, "substantially similar") is in unreduce.c.
        Since reducing was only used by very early PKZIP beta versions (0.9x),
        support for it is now omitted by default (COPYRIGHT_CLEAN).  To in-
        clude unreducing capability, define USE_SMITH_CODE and replace the
        stub unreduce.c source file by the separatly distributed full source
        code module.  Note that this subjects UnZip to any and all restrictions
        in Smith's copyright; see the UnZip COPYING.OLD file for details.

      USE_CRYPT
        Enable decryption support for all binaries.  The default setting
        is to disable decryption support for the SFX stub to keep its size
        as small as possible. For other binaries of the UnZip distribution,
        decryption support is enabled by default.

      NO_CRYPT
        Disable decryption support for all binaries.

      PASSWD_FROM_STDIN   (with full crypt sources only; Unix, VMS only)
        Used to allow the password on encrypted files to be read from stdin
        rather than the default stderr.  This was useful for those who wished
        to automate the testing or decoding of encrypted archives (say, in a
        shell script via ``echo "password" | unzip -tq archive''), but as of
        version 5.3, UnZip has a -P option for passing a password directly to
        the program.  PASSWD_FROM_STDIN will therefore probably be phased out
        in future versions.  Note that the same security warnings given in the
        description of the -P option apply here as well.

      UNICODE_SUPPORT
        Enable restoring from UTF-8 encoded paths.  These paths are stored
        in extra fields in a backward-compatible way so that archives with
        UTF-8 paths still work on zips and unzips that don't support Unicode.
        This support follows the recent additions to the PKWare AppNote for
        Unicode support, except that Unicode comments on systems where UTF-8
        is not the current character set is not implemented in this release.

        Internally, Unicode support can be achieved by three methods:
        a) The charset encoding used by the system is already UTF-8, so
           the program just has to select the UTF-8 versions of the stored
           filenames for file name handling.
           This method is enabled by setting the symbol UTF8_MAYBE_NATIVE;
           this activates code to check for native UTF-8 encoding in the
           locale settings.
        b) The operating system and the compilation environment support
           "wide character" data in Unicode encoding (UCS-2/UTF-16 or UCS-4),
           which are used to translate between UTF-8 and the native
           extended-ASCII character encoding.
           The code for this method is activated by setting the preprocessor
           symbol UNICODE_WCHAR.
           It may be activated together with UTF8_MAYBE_NATIVE to provide
           more versatile Unicode support and additional "debugging" options
           for checking the correct recognition of non-ASCII Unicode
           characters.
        c) The operating system and the compilation environment allow to use
           unicode-encoded "wide character" data for native text strings
           support.
           Complete support for this method requires a throughout revision
           of the UnZip code. All internal string handling and text output
           needs to be ported to use wchar_t character storage.
           This porting is still in an experimental stage and not ready
           for general distribution.

        On some ports UNICODE_SUPPORT is set automatically:
        - WIN32 (and WinCE) use method b) by defining UNICODE_SUPPORT and
          UNICODE_WCHAR.
        - On Unix, the automatic configuration script enables UNICODE_WCHAR
          if ISO-10646 compatible wide characters are supported and
          UTF8_MAYBE_NATIVE if the locale detection call is available.
        For these ports, setting NO_UNICODE_SUPPORT forces deactivation of
        the Unicode support.

      NO_SETLOCALE (for Unix)
        On Unix, it is now assumed that <locale.h> and the setlocale function
        are available, to setup locale-aware filtering of displayed filenames.
        The option NO_SETLOCALE allows to disable the dependency on <locale.h>
        and setlocale() on systems where this assumption is invalid (and the
        auto-configuring make target "generic" cannot be used for capabilities
        detection).

      _MBCS
      NO_MBCS
       Enable multi-byte character set support.  This is the default for the
       Human68k system (originated from Japan) and for Win32 (here only DBCS
       "double-byte character set" support).  The MBCS support should also be
       enabled on systems which are capable of using UTF-8 as native charset.
       For MBCS support, the C runtime library must supply implementations
       for the mblen() function and the MB_CUR_MAX runtime macro/function.
       The NO_MBCS symbol allows to explicitely disable MBCS support for
       testing purpose, or when MBCS support does not work as expected.

      HAVE_WORKING_ISPRINT
      NO_WORKING_ISPRINT
        The symbol HAVE_WORKING_ISPRINT enables enhanced non-printable chars
        filtering for filenames in the fnfilter() function.  On some systems
        (Unix, VMS, some Win32 compilers), this setting is enabled by default.
        In cases where isprint() flags printable extended characters as
        unprintable, defining NO_WORKING_ISPRINT allows to disable the enhanced
        filtering capability in fnfilter().  (The ASCII control codes 0x01 to
        0x1f are always escaped on ASCII systems.)

      DEBUG
        Used for debugging purposes; enables Trace() statements.  Generally
        it's best to compile only one or two modules this way.

      DEBUG_TIME
        Used for debugging the timezone code in fileio.c; enables TTrace()
        statements.  This code is only used for the freshen/update options
        (-f and -u), and non-Unix compilers often get it wrong.


(4) If you regularly compile new versions of UnZip and always want the same
    non-standard option(s), you may wish to add it (them) to the LOCAL_UNZIP
    environment variable (assuming it's supported in your makefile).  Under
    MS-DOS, for example, add this to AUTOEXEC.BAT:

        set LOCAL_UNZIP=-DDOSWILD -DDATE_FORMAT=DF_DMY

    You can also use the variable to hold special compiler options (e.g.,
    -FPi87 for Microsoft C, if the x87 libraries are the only ones on your
    disk and they follow Microsoft's default naming conventions; MSC also
    supports the CL environment variable, however).


(5) Run the make utility on your chosen makefile:

      Unix
        For most systems it's possible to invoke the makefile in place, at
        the possible cost of an ignorable warning; do "make -f unix/Makefile
        list" to get a list of possible system targets, and then "make -f
        unix/Makefile target" for your chosen target.  The "generic" target
        works for most systems, but if it fails with a message about ftime()
        unresolved or timezone redefined, do "make clean", "make help", and
        then either "make generic2" or "make generic3" as instructed.  If all
        else fails, read the makefile itself; it contains numerous comments.
        (One of these days we'll make a configure script that automates this
        procedure better.)