home *** CD-ROM | disk | FTP | other *** search
/ Vectronix 2 / VECTRONIX2.iso / FILES_01 / WP5_A.LZH / WP5_A.MSA / ST_UNZIP.DOC < prev    next >
Text File  |  1985-11-20  |  20KB  |  398 lines

  1.          This is my plea for contributions to compensate for the time
  2.          and effort to continue development of ST_UNZIP.  I have a
  3.          wife, three children, pay child support for children from
  4.          a previous marriage, and hold a regular job.
  5.          
  6.          Right now this program is mainly used by users of 
  7.          PC-DITTO to extract files faster than PKUNZIP can while
  8.          running under PC-DITTO.
  9.          
  10.          I would like to integrate ST_UNZIP into an integrated
  11.          program that will ZIP and UNZIP files on the Atari ST.
  12.          
  13.          Registered users will automatically receive  news of
  14.          version changes.  If they then send a blank disk or
  15.          the equivalent of $3.00 US dollars, I will send the
  16.          latest version and documentation.
  17.          
  18.          The sugested contribution is the equivalent of $10.00
  19.          (US dollars).  Deutsch marks, francs, roubles, or 
  20.          other monetary units are welcome.
  21.          
  22.          Send to:
  23.                  Arthur Cravener
  24.                  1256 Church Street
  25.                  Reading, PA  19601
  26.                  U.S.A.
  27.          
  28.             Thank-you and I hope you find this program useful.                  
  29.           =====================================================
  30.  
  31.  
  32.  
  33.  
  34.  
  35.           ST_UNZIP...a ZIP file extraction utility for the Atari ST.
  36.                                version 2.70
  37.                                  11/24/89
  38.  
  39.                              EXTRACTING A ZIP FILE
  40.  
  41.               This section will describe some simple examples, illustrating
  42.           the command format for extracting files from a ZIP file.
  43.  
  44.           ||============================================================||
  45.           ||                                                            ||
  46.           ||                                                            ||
  47.           ||                 How to Extract a ZIP file                  ||
  48.           ||                                                            ||
  49.           || A ZIP file is one which holds much information in a        ||
  50.           || greatly reduced space.  Use the ST_UNZIP program to        ||
  51.           || extract compressed files from a ZIP file.  An entire ZIP   ||
  52.           || file can be extracted, or a specific file  can be          ||
  53.           || delegated to be extracted.                                 ||
  54.           ||                                                            ||
  55.           || There are four main parameters on the ST_UNZIP command:    ||
  56.           ||                                                            ||
  57.           || 1. The command options           |  letter commands        ||
  58.           ||                                  |  example: -v=view files ||
  59.           ||                                                            ||
  60.           || 2. The ZIP file name             |  zipfile.zip            ||
  61.           ||                                                            ||
  62.           || 3. Selected file to be extracted |  foo.txt                ||
  63.           ||                                                            ||
  64.           || 4. The destination where you want| Default = directory     ||
  65.           ||    the extracted information to  | where program is started||
  66.           ||    be located (optional)         |                         ||
  67.           ||                                                            ||
  68.           ||  Examples:                                                 ||
  69.           ||                                                            ||
  70.           ||    x zipfile.zip  A:\                                      ||
  71.           ||                                                            ||
  72.           || This command will extract all the files in the ZIP file    ||
  73.           || zipfile.zip.  It will locate extracted files to the A      ||
  74.           || drive.                                                     ||
  75.           ||                                                            ||
  76.           ||                                                            ||
  77.           ||    i  A:\zipfile.zip  foo.c                                ||
  78.           ||                                                            ||
  79.           || In this example the ZIP file located in the A drive will   ||
  80.           || be extracted  to the drive and/or folder ST_UNZIP is run   ||
  81.           || from, this is the default.  Only the foo.c file will be    ||
  82.           || extracted.                                                 ||
  83.           ||                                                            ||
  84.           ||     xo \collect\zipfile.zip  A:\                           ||
  85.           ||                                                            ||
  86.           || In this example, the path location of the ZIP file is      ||
  87.           || specified.   The files will be extracted to the A drive.   ||
  88.           || With the 'xo' option, any file on the A drive with the same||
  89.           || name will be overwritten _without_ asking for user         ||        
  90.           || confirmation.                                              ||
  91.           ||============================================================||
  92.  
  93.  
  94.                               ST_UNZIP  GUIDE
  95.  
  96.           The following table will provide a quick  guide to all of
  97.           the options of ST_UNZIP.  The command syntax is also shown
  98.           below.
  99.  
  100.           ||==============================================================||
  101.           ||                                                              ||
  102.           ||                        ST_UNZIP                              ||
  103.           ||                                                              ||
  104.           || ST_UNZIP [options] zipfile [d:path\] [file...]               ||
  105.           ||                                                              ||
  106.           || zipfile = ZIP file name.  Default extension is .zip          ||
  107.           || file    = Names of files to compress. Wildcards *, ?  are ok.||
  108.           ||           Default is ALL files.                              ||
  109.           || list    = An optional list file name.                        ||
  110.           ||                                                              ||
  111.           ||                                                              ||
  112.           || Options are:                                                 ||
  113.           ||            c[m]= extract a file to screen                    ||
  114.           ||              m = extracts a screen-full at a time            || 
  115.           ||                  and more                                    ||
  116.           ||            i[o]= extract individual file to disk             ||
  117.           ||            p   = extract a text file to printer              ||
  118.           ||            v   = verbose list to screen                      ||
  119.           ||              o = overwrite existing files:                   ||
  120.           ||            x[o]= extract all files from zipfile              ||           
  121.           ||            t   = test zipfile crc integrity                  ||           
  122.           ||==============================================================||
  123.  
  124.                        DESCRIPTION OF COMMAND OPTIONS
  125.  
  126.  
  127.               The command options used in extracting a ZIP file will be
  128.           explained in detail in this section.  
  129.  
  130.           - The command options must be the first parameter on the
  131.             command line.
  132.  
  133.           - The first filename listed on the command line will be
  134.             interpreted as the ZIP file to be extracted.  When using
  135.             the 'i' option, the next filename will be interpreted as
  136.             the specific file to be extracted from the zipfile. 
  137.           
  138.           - The command can be typed using either upper case, lower
  139.             case, or any combination.
  140.  
  141.           - All command options can be preceded by a '-' character
  142.             (i.e. -v).  At present there is no need to use this
  143.             character.  This flag will be used in future versions 
  144.             of ST_UNZIP.
  145.  
  146.           - Unrelated options of ST_UNZIP cannot be combined.
  147.  
  148.           - The default values for the command line are as follows:
  149.  
  150.  
  151.             1. If no extension is specified for the ZIP file the .zip
  152.                extension is assumed.
  153.  
  154.             2. If no destination is specified for the extracted files, they
  155.                will be located in directory that the program is being run
  156.                from.
  157.  
  158.             3. If no file specs (filenames without wildcards) are
  159.                listed, the default is all(*.*).
  160.  
  161.  
  162.               The following table lists all the options valid with the
  163.           PKZIP command.  A brief summary is also given in the table.  The
  164.           options are explained in detail, along with programming examples,
  165.           following the table.
  166.  
  167.                           Table 1   ST_UNZIP Command Options
  168.           ==============================================================
  169.  
  170.           OPTION         SUMMARY
  171.  
  172.           -c[m]          Extracts a particular file to the console or
  173.                          with 'm' option extracts to console a screen
  174.                          full at a time, and more.
  175.  
  176.           -i[o]          Extract a particular file to disk.  
  177.  
  178.           -p             Extracts a particular text file to a printer.
  179.  
  180.           -v             Verbose/views technical information about
  181.                          files in the ZIP.
  182.  
  183.           -x[o]          Extracts files from the ZIP file.
  184.              
  185.              o           Overwrite existing files:  
  186.                          Used along with either 'x' or 'i' option.    
  187.              
  188.           -t             reads each file in zipfile then calculates
  189.                          the CRC value.  displays (OK!) if crc good,
  190.                          and displays actual and "should be" values.   
  191.  
  192.           Notes:  Parameters listed in [ ] are optional.
  193.                  o   Overwrites existing files without asking for
  194.                      user confirmation.
  195.           ================================================================  
  196.  
  197.  
  198.               This section will give a detailed explanation of the command
  199.           options used in the ST_UNZIP command.
  200.  
  201.               The command options are explained in groups determined by
  202.           function.  The options pertaining to extracting ZIP files are
  203.           explained first, followed by the view options, print options, and
  204.           miscellaneous options.
  205.  
  206.  
  207.           -x  Extract files from a ZIP file
  208.  
  209.               This command will extract all files from a ZIP file.  
  210.           The extracted files will be located in the current
  211.           directory unless you specify a destination.  The -x option
  212.           is the default option for the ST_UNZIP command.  If no
  213.           option is listed on the command  -x will be assumed.
  214.  
  215.               If a file being extracted already exists at the same
  216.           destination where the extracted files are being located, the
  217.           program will prompt you for confirmation before it overwrites the
  218.           existing file.
  219.  
  220.  
  221.           Example:   C:\DB\ST_UNZIP -x  A:lists.zip
  222.  
  223.               In the above example, all of the files will be extracted
  224.           from the ZIP file called 'lists'. The ZIP file is located on
  225.           the A drive,  they will be extracted to the C:\DB\ directory.
  226.  
  227.               If files in 'lists.zip' already exists at 'C:\DB\', the
  228.           program will prompt you for confirmation before it overwrites 
  229.           the existing file.
  230.           ============================================================
  231.  
  232.  
  233.           -xo Extracts files from ZIP file and overwrite existing files
  234.               on disk.
  235.  
  236.               This command will extract files from a ZIP file and
  237.           automatically overwrite any same-named files found at the
  238.           destination where the extracted files are being located.  The
  239.           program will NOT prompt you for confirmation before overwriting
  240.           these files.
  241.  
  242.              The extracted files will be located in the current directory 
  243.           unless you specify a destination.
  244.  
  245.           Example:   C:ST_UNZIP -xo zipfile 
  246.  
  247.               In the above example,  all files will be extracted
  248.           from the ZIP file called 'zipfile' (the .zip extension is
  249.           assumed).  As the files are being extracted any file with
  250.           the same name in the current directory (C:) will be 
  251.           overwritten.
  252.           ============================================================
  253.           
  254.  
  255.           -i  Extract an individual file from a ZIP file
  256.  
  257.               This command will extract an individual file from a ZIP   
  258.           file.  The extracted file will be located in the current
  259.           directory unless you specify a destination.
  260.  
  261.               If a file being extracted already exists at the same
  262.           destination where the extracted files are being located, the
  263.           program will prompt you for confirmation before it overwrites
  264.           the existing file.
  265.  
  266.  
  267.           Example:   C:ST_UNZIP -i zipfile stuff.exe E:\foo\
  268.  
  269.               In the above example,  the 'stuff.exe' file will be extracted
  270.           from the ZIP file called 'zipfile' (the .zip extension is
  271.           assumed).  The file will be extracted to the 'E:\foo\' directory.
  272.           
  273.               If 'stuff.exe' already exists at 'E:\foo\', the program will
  274.           prompt you for confirmation before it overwrites the existing file.
  275.            ============================================================
  276.  
  277.  
  278.           -io Extract an individual file from ZIP file and overwrite
  279.               any existing file with same name.
  280.  
  281.               This command will extract an individual file from a ZIP
  282.           file and automatically overwrite any same-named file found. The
  283.           program will NOT prompt you for confirmation before overwriting
  284.           this file.
  285.  
  286.              The extracted file will be located in the current directory 
  287.           unless you specify a destination.
  288.  
  289.  
  290.           Example:   C:ST_UNZIP -xo zipfile stuff.exe
  291.  
  292.               In the above example,  the 'stuff.exe' file will be extracted
  293.           from the ZIP file called 'zipfile' (the .zip extension is
  294.           assumed).  As the file is being extracted any file with
  295.           the same name in the current directory (C:)will be 
  296.           overwritten.
  297.           ============================================================
  298.  
  299.  
  300.           -c     Extract files from a ZIP file and display them on the
  301.                  screen
  302.  
  303.               This command will extract files from a ZIP file and display
  304.           them on the monitor.  The extracted files will scroll
  305.           continuously on the screen.
  306.  
  307.           
  308.           Example:   A:ST_UNZIP  -c d:\schedule\zipfile dates.doc
  309.  
  310.               In this example, the file 'dates.doc' will be extracted from
  311.           the 'zipfile' file in directory 'd:\schedule\' and displayed on 
  312.           the screen and scroll continuously.
  313.  
  314.           -cm    Lists all files in ZIP file and steps through them one at
  315.                  a time prompting for action
  316.  
  317.               This commmand will list all files, step through them, and
  318.           prompt for (N)ext (V)iew (R)elist/(O)ne (Q)uit.
  319.  
  320.           Example:   C:ST_UNZIP  -cm e:\temp\zipfile
  321.  
  322.               The above example will list the contents of 'zipfile'.
  323.           After the listing each file will be stepped to and a
  324.           menu of commands  will be provided.  If you select (N)ext,
  325.           the next file in the 'zipfile' will be the choice for action.
  326.           If you choose to (V)iew a file, the first display will be a
  327.           screen-full of the selected file.  You will then be prompted
  328.           for "More:  (Y)es, (N)o, (C)ontinuous?".  Selecting
  329.           (Y)es  will display another screen full of text.  Selecting 
  330.           (N)o will abort the (V)iew action on the present file and 
  331.           skip to the next file in the "zipfile".
  332.  
  333.               If the selection is (C)ontinuous, the file selected will
  334.           scroll continuously.  You can pause the display by using
  335.           [Control-s]:(hold the 'Control' key down and press 's'),
  336.           to resume the display hit [Control-q].
  337.  
  338.               After the initial detailed verbose listing, the display
  339.           defaults to an alphabetical list of filenames only.  You can
  340.           use the (R)elist command to redisplay the detailed verbose
  341.           listing.  You can also call up an individual file and view
  342.           its detailed verbose information by using the (O)ne command
  343.           selection.   Selecting (O)ne will display: (N)ext (V)iew 
  344.           (M)ain menu.  The (N)ext command will allow you to skip
  345.           to the particular file you wish detailed verbose information
  346.           on.  When you get to the file name you wish to examine,
  347.           selecting (V)iew will display detailed verbose information
  348.           about that file only.  Selecting (M)ain menu returns you to
  349.           the command line prompt: (N)ext (V)iew (R)elist/(O)ne (Q)uit.
  350.           
  351.           
  352.                    Non-text files will not be displayed.
  353.           ============================================================
  354.  
  355.  
  356.           -v  Verbose\view technical information
  357.  
  358.               This option will display technical information concerning the
  359.           files contained within a ZIP file.  
  360.  
  361.                The following information about each file in the ZIP file
  362.           will be displayed (scrolled) on the screen.
  363.  
  364.                       Name        Name of the file
  365.                       Length      Original length of the file
  366.                       Stowage     Type of file compression used, Implode or
  367.                                   Shrink, (or Reduce if an older version of
  368.                                   PKZIP was used)
  369.                       SF          Percent reduction in file size
  370.                       Size        Size of the compressed file
  371.                       Date        Actual date of the file
  372.                       Time        Actual time of the file
  373.                       CRC-32      The CRC-32 value of the file
  374.           ============================================================
  375.  
  376.  
  377.           -p   Extract  a particular text file to a printer
  378.  
  379.               This option is used to extract files from a ZIP file and send
  380.           the output to a printer.  
  381.  
  382.  
  383.           Example:   C:ST_UNZIP -p zipfile.zip stuff.doc
  384.  
  385.               In the above example, the 'stuff.doc' file will be extracted
  386.           from 'zipfile.zip' to the printer.
  387.           ============================================================
  388.           
  389.           
  390.           -t   Tests the CRC integrity of all files in a zipfile
  391.           
  392.                This options reads the zipfile registered CRC value then
  393.            calculates the files actual CRC value.  If the two values match,
  394.            an "OK!" is displayed, if they do not match, a bell is sounded
  395.            and an error message is displayed for the particular file with
  396.            the error.    
  397. ============================================================================
  398.                                  The End