home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / unzip511.zip / unzipsfx.doc < prev    next >
Text File  |  1994-08-02  |  11KB  |  246 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: 2 Aug 94 (v5.11)                 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.           ``unzip foo *.[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.  
  81. OPTIONS
  82.      unzipsfx supports the following unzip(1L) options:   -c  and
  83.      -p  (extract  to standard output/screen), -f and -u (freshen
  84.      and  update  existing  files  upon  extraction),  -t   (test
  85.      archive) and -z (print archive comment).  All normal listing
  86.      options (-l, -v and -Z) have been removed, but  the  testing
  87.      option (-t) may be used as a ``poor man's'' listing.  Alter-
  88.      natively, those creating self-extracting archives  may  wish
  89.      to include a short listing in the zipfile comment.
  90.  
  91.      See unzip(1L) for  a  more  complete  description  of  these
  92.      options.
  93.  
  94. MODIFIERS
  95.      unzipsfx currently supports  all  unzip(1L)  modifiers:   -a
  96.      (convert  text  files),  -n (never overwrite), -o (overwrite
  97.      without prompting), -q (operate quietly),  -C  (match  names
  98.      case-insenstively), -L (convert uppercase-OS names to lower-
  99.      case), -j (junk paths) and -V (retain version numbers); plus
  100.      the   following   operating-system   specific  options:   -X
  101.      (restore VMS owner/protection info), -s (convert  spaces  in
  102.      filenames  to  underscores  [DOS, OS/2, NT]) and -$ (restore
  103.      volume label [DOS, OS/2, NT, Amiga]).
  104.  
  105.      (Support for regular ASCII text-conversion may be removed in
  106.      future versions, since it is simple enough for the archive's
  107.      creator to ensure that text files have the appropriate  for-
  108.      mat for the local OS.  EBCDIC conversion will of course con-
  109.      tinue to be supported since the zipfile format implies ASCII
  110.      storage of text files.)
  111.  
  112. Info-ZIP          Last change: 2 Aug 94 (v5.11)                 2
  113.  
  114. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  115.  
  116.      See unzip(1L) for  a  more  complete  description  of  these
  117.      modifiers.
  118.  
  119. ENVIRONMENT OPTIONS
  120.      unzipsfx uses the same environment  variables  as  unzip(1L)
  121.      does,  although  this  is likely to be an issue only for the
  122.      person creating and  testing  the  self-extracting  archive.
  123.      See unzip(1L) for details.
  124.  
  125. DECRYPTION
  126.      Decryption is supported exactly as in  unzip(1L);  that  is,
  127.      interactively with a non-echoing prompt for the password(s).
  128.      See unzip(1L) for details.  Once again,  note  that  if  the
  129.      archive  has  no encrypted files there is no reason to use a
  130.      version of unzipsfx with decryption support; that only  adds
  131.      to the size of the archive.
  132.  
  133. EXAMPLES
  134.      To create a self-extracting archive letters from  a  regular
  135.      zipfile letters.zip and change the new archive's permissions
  136.      to be world-executable under Unix:
  137.  
  138.          cat unzipsfx letters.zip > letters
  139.          chmod 755 letters
  140.  
  141.      To create the same archive under MS-DOS, OS/2  or  NT  (note
  142.      the use of the /b [binary] option to the copy command):
  143.  
  144.          copy /b unzipsfx.exe+letters.zip letters.exe
  145.  
  146.      Under VMS:
  147.  
  148.          copy unzipsfx.exe,letters.zip letters.exe
  149.          letters == "$currentdisk:[currentdir]letters.exe"
  150.  
  151.      (The VMS append command may also be used.  The  second  com-
  152.      mand installs the new program as a ``foreign command'' capa-
  153.      ble of taking  arguments.)  To  test  (or  list)  the  newly
  154.      created self-extracting archive:
  155.  
  156.          letters -t
  157.  
  158.      To test letters quietly, printing  only  a  summary  message
  159.      indicating whether the archive is OK or not:
  160.  
  161.          letters -tq
  162.  
  163.      To extract the complete contents into the current directory,
  164.      recreating all files and subdirectories as necessary:
  165.  
  166.          letters
  167.  
  168. Info-ZIP          Last change: 2 Aug 94 (v5.11)                 3
  169.  
  170. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  171.  
  172.      To extract only the README  file  to  standard  output  (the
  173.      screen):
  174.  
  175.          letters -c README
  176.  
  177.      To print only the zipfile comment:
  178.  
  179.          letters -z
  180.  
  181. LIMITATIONS
  182.      The principle and fundamental limitation of unzipsfx is that
  183.      it  is  not  portable across architectures or operating sys-
  184.      tems, and therefore neither are the resulting archives.  For
  185.      some  architectures  there  is  limited portability, however
  186.      (e.g., between some flavors of Intel-based Unix).
  187.  
  188.      unzipsfx has no knowledge of the user's PATH, so in  general
  189.      an  archive  must either be in the current directory when it
  190.      is invoked, or else a full or relative path must  be  given.
  191.      If  a  user attempts to extract the archive from a directory
  192.      in the PATH other than the current one, unzipsfx will  print
  193.      a  warning  to  the  effect, ``can't find myself.''  This is
  194.      always true under Unix and may be true in some  cases  under
  195.      MS-DOS,  depending  on  the compiler used (Microsoft C fully
  196.      qualifies the program name, but other  compilers  may  not).
  197.      Under OS/2 and NT there are operating-system calls available
  198.      which provide the full path name,  so  the  archive  may  be
  199.      invoked  from anywhere in the user's path.  The situation is
  200.      not known for Atari TOS, MacOS, etc.
  201.  
  202.      As noted above, a number of the normal  unzip(1L)  functions
  203.      have  been removed in order to make unzipsfx smaller:  usage
  204.      and diagnostic info, listing  functions  and  extraction  to
  205.      other directories.  Also, only stored and deflated files are
  206.      supported.  The latter  limitation  is  mainly  relevant  to
  207.      those who create SFX archives, however.
  208.  
  209.      VMS users must know how to set up  self-extracting  archives
  210.      as  foreign  commands  in  order  to  use  any of unzipsfx's
  211.      options.  This is not necessary for simple  extraction,  but
  212.      the command to do so then becomes, e.g., ``run letters'' (to
  213.      continue the examples given above).
  214.  
  215.      unzipsfx is not supported on the Amiga because  of  the  way
  216.      the  loader  works;  the  entire  archive  contents would be
  217.      loaded into memory by default.  It may be possible  to  work
  218.      around this by defining the attached archive to be a ``debug
  219.      hunk,'' but compatibility problems between the ROM levels of
  220.      older  Amigas  and  newer  ones are likely to cause problems
  221.      regardless.
  222.  
  223. Info-ZIP          Last change: 2 Aug 94 (v5.11)                 4
  224.  
  225. UNZIPSFX(1L)      MISC. REFERENCE MANUAL PAGES       UNZIPSFX(1L)
  226.  
  227.      All current bugs in unzip(1L) exist in unzipsfx as well.
  228.  
  229. DIAGNOSTICS
  230.      unzipsfx's exit status (error level) is identical to that of
  231.      unzip(1L); see the corresponding man page.
  232.  
  233. SEE ALSO
  234.      funzip(1L), unzip(1L), zip(1L),  zipcloak(1L),  zipgrep(1L),
  235.      zipinfo(1L), zipnote(1L), zipsplit(1L)
  236.  
  237. AUTHORS
  238.      Greg Roelofs was responsible for the basic modifications  to
  239.      UnZip  necessary  to create UnZipSFX.  See unzip(1L) for the
  240.      current list of zip-bugs authors, or the  file  CONTRIBS  in
  241.      the  UnZip source distribution for the full list of Info-ZIP
  242.      contributors.
  243.  
  244. Info-ZIP          Last change: 2 Aug 94 (v5.11)                 5
  245.  
  246.