home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / unzip512.zip / unzipsfx.doc < prev    next >
Text File  |  1994-08-25  |  12KB  |  284 lines
  1.  
  2. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  3.  
  4. NAME
  5.      unzipsfx  -  self-extracting  stub  for  prepending  to  ZIP
  6.      archives
  7.  
  8. SYNOPSIS
  9.      <name  of  unzipsfx+archive   combo>   [-cfptuz[ajnoqsCLV$]]
  10.      [file(s) ... [-x xfile(s) ...]]
  11.  
  12. DESCRIPTION
  13.      unzipsfx is a modified version of unzip(1L) designed  to  be
  14.      prepended  to  existing  ZIP archives in order to form self-
  15.      extracting archives.  Instead of taking its  first  non-flag
  16.      argument  to  be  the  zipfile(s)  to be extracted, unzipsfx
  17.      seeks itself under the name by  which  it  was  invoked  and
  18.      tests  or  extracts  the  contents  of the appended archive.
  19.      Because the executable stub adds bulk to  the  archive  (the
  20.      whole  purpose  of  which  is to be as small as possible), a
  21.      number of the regular version's less-vital capabilities have
  22.      been  removed.   Among these are the usage (or help) screen,
  23.      the listing and diagnostic functions (-l and -v), the  abil-
  24.      ity to decompress older compression formats (the ``reduce,''
  25.      ``shrink'' and ``implode''  methods),  and  the  ability  to
  26.      extract  to a directory other than the current one.  Decryp-
  27.      tion is supported as a compile-time  option  but  should  be
  28.      avoided  unless  the  attached  archive  contains  encrypted
  29.      files.
  30.  
  31.      Note that self-extracting archives made with unzipsfx are no
  32.      more  (or  less) portable across different operating systems
  33.      than is the unzip executable itself.   In  general  a  self-
  34.      extracting  archive  made  on  a particular Unix system, for
  35.      example, will only self-extract under  the  same  flavor  of
  36.      Unix.  Regular unzip may still be used to extract the embed-
  37.      ded archive as with any normal  zipfile,  although  it  will
  38.      generate  a harmless warning about extra bytes at the begin-
  39.      ning of the zipfile.
  40.  
  41. ARGUMENTS
  42.      [file(s)]
  43.           An optional list of archive members  to  be  processed.
  44.           Regular  expressions  (wildcards)  similar  to those in
  45.           Unix egrep(1) may be used to  match  multiple  members.
  46.           These wildcards may contain:
  47.  
  48.           *    matches a sequence of 0 or more characters
  49.  
  50.           ?    matches exactly 1 character
  51.  
  52.           [...]
  53.                matches any  single  character  found  inside  the
  54.                brackets;  ranges  are  specified  by  a beginning
  55.                character, a hyphen, and an ending character.   If
  56.  
  57. Info-ZIP         Last change: 28 Aug 94 (v5.12)                 1
  58.  
  59. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  60.  
  61.                an  exclamation point or a caret (`!' or `^') fol-
  62.                lows the left bracket, then the range  of  charac-
  63.                ters within the brackets is complemented (that is,
  64.                anything except the characters inside the brackets
  65.                is considered a match).
  66.  
  67.           (Be sure to quote any character which  might  otherwise
  68.           be  interpreted  or  modified  by the operating system,
  69.           particularly under Unix and VMS.)
  70.  
  71.      [-x xfile(s)]
  72.           An optional list of archive members to be excluded from
  73.           processing.   Since wildcard characters match directory
  74.           separators (`/'), this option may be  used  to  exclude
  75.           any  files  which  are in subdirectories.  For example,
  76.           ``foosfx *.[ch] -x */*'' would  extract  all  C  source
  77.           files  in the main directory, but none in any subdirec-
  78.           tories.  Without the -x option, all C source  files  in
  79.           all  directories within the zipfile would be extracted.
  80.           Unlike in unzip(1L), the -x option may only be used  if
  81.           one  or more files are given.  This is because there is
  82.           no zipfile separating the normal options  from  the  -x
  83.           option,  so  unzipsfx sees it as another normal option.
  84.           For historical reasons, the ``normal'' -x  is  silently
  85.           ignored.  See the EXAMPLES section below.
  86.  
  87.      If unzipsfx is compiled with SFX_EXDIR defined, the  follow-
  88.      ing option is also enabled:
  89.  
  90.      [-d exdir]
  91.           An optional directory to which to  extract  files.   By
  92.           default,  all files and subdirectories are recreated in
  93.           the current directory; the -d option allows  extraction
  94.           in an arbitrary directory (always assuming one has per-
  95.           mission to write to the  directory).   The  option  and
  96.           directory  may  be concatenated without any white space
  97.           between them, but note that this may cause normal shell
  98.           behavior  to  be  suppressed.   In particular, ``-d ~''
  99.           (tilde) is expanded by Unix C shells into the  name  of
  100.           the  user's home directory, but ``-d~'' is treated as a
  101.           literal subdirectory ``~'' of  the  current  directory.
  102.           As  with  -x,  the -d option may only be used if one or
  103.           more files are given.
  104.  
  105. OPTIONS
  106.      unzipsfx supports the following unzip(1L) options:   -c  and
  107.      -p  (extract  to standard output/screen), -f and -u (freshen
  108.      and  update  existing  files  upon  extraction),  -t   (test
  109.      archive) and -z (print archive comment).  All normal listing
  110.      options (-l, -v and -Z) have been removed, but  the  testing
  111.      option (-t) may be used as a ``poor man's'' listing.  Alter-
  112.      natively, those creating self-extracting archives  may  wish
  113.  
  114. Info-ZIP         Last change: 28 Aug 94 (v5.12)                 2
  115.  
  116. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  117.  
  118.      to include a short listing in the zipfile comment.
  119.  
  120.      See unzip(1L) for  a  more  complete  description  of  these
  121.      options.
  122.  
  123. MODIFIERS
  124.      unzipsfx currently supports  all  unzip(1L)  modifiers:   -a
  125.      (convert  text  files),  -n (never overwrite), -o (overwrite
  126.      without prompting), -q (operate quietly),  -C  (match  names
  127.      case-insenstively), -L (convert uppercase-OS names to lower-
  128.      case), -j (junk paths) and -V (retain version numbers); plus
  129.      the   following   operating-system   specific  options:   -X
  130.      (restore VMS owner/protection info), -s (convert  spaces  in
  131.      filenames  to  underscores  [DOS, OS/2, NT]) and -$ (restore
  132.      volume label [DOS, OS/2, NT, Amiga]).
  133.  
  134.      (Support for regular ASCII text-conversion may be removed in
  135.      future versions, since it is simple enough for the archive's
  136.      creator to ensure that text files have the appropriate  for-
  137.      mat for the local OS.  EBCDIC conversion will of course con-
  138.      tinue to be supported since the zipfile format implies ASCII
  139.      storage of text files.)
  140.  
  141.      See unzip(1L) for  a  more  complete  description  of  these
  142.      modifiers.
  143.  
  144. ENVIRONMENT OPTIONS
  145.      unzipsfx uses the same environment  variables  as  unzip(1L)
  146.      does,  although  this  is likely to be an issue only for the
  147.      person creating and  testing  the  self-extracting  archive.
  148.      See unzip(1L) for details.
  149.  
  150. DECRYPTION
  151.      Decryption is supported exactly as in  unzip(1L);  that  is,
  152.      interactively with a non-echoing prompt for the password(s).
  153.      See unzip(1L) for details.  Once again,  note  that  if  the
  154.      archive  has  no encrypted files there is no reason to use a
  155.      version of unzipsfx with decryption support; that only  adds
  156.      to the size of the archive.
  157.  
  158. EXAMPLES
  159.      To create a self-extracting archive letters from  a  regular
  160.      zipfile letters.zip and change the new archive's permissions
  161.      to be world-executable under Unix:
  162.  
  163.          cat unzipsfx letters.zip > letters
  164.          chmod 755 letters
  165.  
  166.      To create the same archive under MS-DOS, OS/2  or  NT  (note
  167.      the use of the /b [binary] option to the copy command):
  168.  
  169. Info-ZIP         Last change: 28 Aug 94 (v5.12)                 3
  170.  
  171. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  172.  
  173.          copy /b unzipsfx.exe+letters.zip letters.exe
  174.  
  175.      Under VMS:
  176.  
  177.          copy unzipsfx.exe,letters.zip letters.exe
  178.          letters == "$currentdisk:[currentdir]letters.exe"
  179.  
  180.      (The VMS append command may also be used.  The  second  com-
  181.      mand installs the new program as a ``foreign command'' capa-
  182.      ble of taking  arguments.)  To  test  (or  list)  the  newly
  183.      created self-extracting archive:
  184.  
  185.          letters -t
  186.  
  187.      To test letters quietly, printing  only  a  summary  message
  188.      indicating whether the archive is OK or not:
  189.  
  190.          letters -tq
  191.  
  192.      To extract the complete contents into the current directory,
  193.      recreating all files and subdirectories as necessary:
  194.  
  195.          letters
  196.  
  197.      To extract all *.txt files (in Unix quote the `*'):
  198.  
  199.          letters *.txt
  200.  
  201.      To extract everything except the *.txt files:
  202.  
  203.          letters * -x *.txt
  204.  
  205.      (Note that with regular unzip(1L) it would not be  necessary
  206.      to  use the first `*'; ``unzip letters -x *.txt'' would work
  207.      equally well.  With unzipsfx the -x option would be silently
  208.      ignored  and the effect would be the same as in the previous
  209.      example, i.e.,  the  opposite  of  what  was  intended.)  To
  210.      extract  only  the  README  file  to  standard  output  (the
  211.      screen):
  212.  
  213.          letters -c README
  214.  
  215.      To print only the zipfile comment:
  216.  
  217.          letters -z
  218.  
  219. LIMITATIONS
  220.      The principle and fundamental limitation of unzipsfx is that
  221.      it  is  not  portable across architectures or operating sys-
  222.      tems, and therefore neither are the resulting archives.  For
  223.      some  architectures  there  is  limited portability, however
  224.      (e.g., between some flavors of Intel-based Unix).
  225.  
  226. Info-ZIP         Last change: 28 Aug 94 (v5.12)                 4
  227.  
  228. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  229.  
  230.      unzipsfx has no knowledge of the user's PATH, so in  general
  231.      an  archive  must either be in the current directory when it
  232.      is invoked, or else a full or relative path must  be  given.
  233.      If  a  user attempts to extract the archive from a directory
  234.      in the PATH other than the current one, unzipsfx will  print
  235.      a  warning  to  the  effect, ``can't find myself.''  This is
  236.      always true under Unix and may be true in some  cases  under
  237.      MS-DOS,  depending  on  the compiler used (Microsoft C fully
  238.      qualifies the program name, but other  compilers  may  not).
  239.      Under OS/2 and NT there are operating-system calls available
  240.      which provide the full path name,  so  the  archive  may  be
  241.      invoked  from anywhere in the user's path.  The situation is
  242.      not known for Atari TOS, MacOS, etc.
  243.  
  244.      As noted above, a number of the normal  unzip(1L)  functions
  245.      have  been removed in order to make unzipsfx smaller:  usage
  246.      and diagnostic info, listing  functions  and  extraction  to
  247.      other directories.  Also, only stored and deflated files are
  248.      supported.  The latter  limitation  is  mainly  relevant  to
  249.      those who create SFX archives, however.
  250.  
  251.      VMS users must know how to set up  self-extracting  archives
  252.      as  foreign  commands  in  order  to  use  any of unzipsfx's
  253.      options.  This is not necessary for simple  extraction,  but
  254.      the command to do so then becomes, e.g., ``run letters'' (to
  255.      continue the examples given above).
  256.  
  257.      unzipsfx is not supported on the Amiga because  of  the  way
  258.      the  loader  works;  the  entire  archive  contents would be
  259.      loaded into memory by default.  It may be possible  to  work
  260.      around this by defining the attached archive to be a ``debug
  261.      hunk,'' but compatibility problems between the ROM levels of
  262.      older  Amigas  and  newer  ones are likely to cause problems
  263.      regardless.
  264.  
  265.      All current bugs in unzip(1L) exist in unzipsfx as well.
  266.  
  267. DIAGNOSTICS
  268.      unzipsfx's exit status (error level) is identical to that of
  269.      unzip(1L); see the corresponding man page.
  270.  
  271. SEE ALSO
  272.      funzip(1L), unzip(1L), zip(1L),  zipcloak(1L),  zipgrep(1L),
  273.      zipinfo(1L), zipnote(1L), zipsplit(1L)
  274.  
  275. AUTHORS
  276.      Greg Roelofs was responsible for the basic modifications  to
  277.      UnZip  necessary  to create UnZipSFX.  See unzip(1L) for the
  278.      current list of zip-bugs authors, or the  file  CONTRIBS  in
  279.      the  UnZip source distribution for the full list of Info-ZIP
  280.      contributors.
  281.  
  282. Info-ZIP         Last change: 28 Aug 94 (v5.12)                 5
  283.  
  284.