home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR3 / EXTPC102.ZIP / EXTRACT.DOC next >
Text File  |  1993-09-24  |  10KB  |  220 lines
  1.  
  2.                     ******* ExtractorPC 1.02 *******
  3.  
  4.    ExtractorPC is a free utility for expanding the files in archives created by
  5.    Compact Pro(tm).  Note:  ExtractorPC is copyrighted 1993 by Bill Goodman.
  6.    The self-extracting code used to distribute this package was produced by LHA
  7.    which is copyrighted 1988-91 by Haruyasu Yoshizaki.
  8.  
  9.  
  10. Requirements
  11.  
  12.    ExtractorPC works with IBM PCs and compatible machines (there are no known
  13.    incompatibilities).  It requires MS-DOS 2.10 or higher.
  14.  
  15.  
  16. About Compact Pro Archives
  17.  
  18.    A Compact Pro (CP) archive may contain the data for one or more Macintosh
  19.    files and folders in compressed format (a folder is the Macintosh equivalent
  20.    of a directory).  It also contains information about the hierarchical
  21.    structure of the folders within the archive.  This information can be used
  22.    to reconstruct an equivalent "tree" of directories from the archive.  Note
  23.    that the names of files and folders within an archive are not necessarily
  24.    unique, i.e., there can be two files named "FOO" within the same folder.
  25.  
  26.    Typically, an archive is stored as a single file;  however, CP archives may
  27.    be divided into "segments".  A typical use for segmented archives is to
  28.    divide a large archive into pieces that are small enough to fit on floppy
  29.    disks.
  30.  
  31.  
  32. About Macintosh Files
  33.  
  34.    Standard Macintosh files have two "forks" - a data fork and a resource
  35.    fork.  Each of these forks contains a separate block of data which roughly
  36.    corresponds to a file on a PC.  You can think of a Macintosh file as being
  37.    two PC-style files which are linked together with a common name.
  38.  
  39.    In general, the data which Macintosh applications store in resource forks
  40.    is not very useful to non-Macintosh applications.  For this reason,
  41.    ExtractorPC only extracts the data forks of Macintosh files by default.
  42.    An option is provided to extract the resource forks for situations where
  43.    the data in the resource fork is required.
  44.  
  45.    When a CP archive is originally created on a Macintosh, it has both a
  46.    resource fork and a data fork.  When it is transferred to a PC, there are
  47.    two common ways of converting the file to PC format.  Some programs will
  48.    convert the file to "MacBinary" format;  this preserves the data in both the
  49.    resource and data forks.  Other programs will discard the resource fork and
  50.    simply copy the data fork to a PC-style file.  Since the resource fork does
  51.    not contain any data needed to extract the contents of the archive, either
  52.    of these formats is acceptable to ExtractorPC.
  53.  
  54.  
  55. Installing ExtractorPC
  56.  
  57.    No special installation of ExtractorPC is required.  You may place a copy
  58.    in your current working directory or any other directory which is
  59.    referenced by MS-DOS's search path.
  60.  
  61.  
  62. Using ExtractorPC
  63.  
  64.    ExtractorPC is a non-interactive, batch-style program.  It is started
  65.    from the DOS command line by entering "EXTRACT" followed by the name of the
  66.    CP archive to be processed (for segmented CP archives, the names of all
  67.    segment files must be specified in order).  ExtractorPC will extract the
  68.    data forks of all the files in the archive and store them hierarchically in
  69.    the current working directory.  If no errors are detected, ExtractorPC
  70.    returns an exit code of 0 (this value may be tested in batch files).  If any
  71.    error is detected, ExtractorPC terminates and returns an exit code of 1.
  72.  
  73.    ExtractorPC's standard operation may be modified by specifying various
  74.    "options" on the command line.  These options are described in the
  75.    following section.
  76.  
  77.  
  78. Command Line Summary
  79.  
  80.    A> EXTRACT ArcName1 <ArcName2> <ArcName3> <-b> <-dDIRPATH> <-eFNAME> <-f>
  81.                                                   <-l> <-o> <-r> <-s> <-u> <-v>
  82.    Items enclosed in "<>" are optional.
  83.  
  84.    ArcName1
  85.       This is the name of the first segment of the archive to be processed.  A
  86.       ".CPT" extension is assumed if no extension is specified.
  87.  
  88.    ArcName2, ArcName3, ...
  89.       These are the names of the segment files for a segmented archive.
  90.       ArcName2 must be the second segment of the archive and ArcName3 must be
  91.       the third segment, etc.
  92.  
  93.    -b   (binary)
  94.       Normally, ExtractorPC will translate extracted text files by adding a
  95.       linefeed character after every carriage return character.  If the "-b"
  96.       option is specified, no text file translation is performed.
  97.  
  98.    -dDIRPATH   (directory)
  99.       By default, the extracted files are stored hierarchically in the current
  100.       working directory.  The "-d" option may be used to specify a different
  101.       destination directory.  DIRPATH is the path to the desired directory.  It
  102.       may be specified relative to the current working directory ("FOO\SAMPLE")
  103.       or it may be specified as an absolute path ("C:\APPS\EXAMPLE\FUNCTIONS").
  104.       The directory must already exist - ExtractorPC will not create it.
  105.  
  106.    -eFNAME   (extract)
  107.       By default, ExtractorPC extracts all files in an archive.  The "-e"
  108.       option may be used to specify one or more individual files or folders to
  109.       be extracted.  If the file/folder name contains blank characters, it must
  110.       be enclosed in quotation marks, e.g. -e"A Long File Name".  Either upper
  111.       or lower case characters may be used to specify the name.  If the named
  112.       file or folder exists in more than one directory, only the first one
  113.       found will be extracted.
  114.  
  115.    -f   (flat extract)
  116.       The "-f" option suppresses the creation of the folder hierarchy stored in
  117.       the archive.  All files will be stored in the destination directory and
  118.       no folders will be created.
  119.  
  120.    -l   (list catalog)
  121.       If the "-l" option is specified, ExtractorPC displays a list of the files
  122.       in the archive, but no files are extracted.  For segmented archives, it
  123.       is not necessary to list all the segment files if the "-l" option is
  124.       used - only the last segment must be entered on the command line.
  125.  
  126.    -o   (overwrite)
  127.       Normally, ExtractorPC will not overwrite any existing files when it is
  128.       extracting files from an archive.  Selecting the "-o" option instructs
  129.       ExtractorPC to delete any pre-existing files necessary during extraction.
  130.  
  131.    -r   (resource forks)
  132.       Selecting the "-r" option directs ExtractorPC to extract the resource
  133.       forks of files rather than the data forks.
  134.  
  135.    -s   (skip errors)
  136.       If an error is detected during the extraction process, ExtractorPC
  137.       normally halts.  Selecting the "-s" option forces ExtractorPC to skip any
  138.       files which produce errors and continue with the remaining files.
  139.  
  140.    -u   (unique names)
  141.       Since Macintosh filenames can be much longer than PC filenames,
  142.       ExtractorPC often has to shorten the names of extracted files. 
  143.       Sometimes it will not be able to extract the files in an archive because
  144.       several of the names end up being the same after they've been shortened.
  145.       If the "-u" option is selected, ExtractorPC will guarantee that all
  146.       filenames and folder names are unique by creating names of the form
  147.       "NAME0000".  These names may be correlated back to the Macintosh
  148.       filenames by reviewing the text which is output to the screen during
  149.       extraction (note this information may be saved to a file by redirecting
  150.       the output to a file).
  151.  
  152.    -v   (validate archive)
  153.       If the "-v" option is specified, ExtractorPC expands all files and
  154.       verifies that the archive data is valid.  No files are created and no
  155.       data is written to disk.
  156.  
  157.  
  158. Example Command Lines
  159.  
  160.    To extract all the files in a CP archive named "BIGFILES.CPT" and store them
  161.    in the current directory, use the following command line:
  162.  
  163.    A> EXTRACT BIGFILES
  164.  
  165.    As a second example, suppose you have a segmented archive consisting of the
  166.    files "BIGARC.#1", "BIGARC.#2", and "BIGARC.#3".  You could expand all the
  167.    files from the archive and save them (ignoring any folder hierarchy) in a
  168.    directory named "C:\SAVE\GRAPHICS" with the following command line:
  169.  
  170.    A> EXTRACT BIGARC.#1 BIGARC.#2 BIGARC.#3 -dC:\SAVE\GRAPHICS -f
  171.  
  172.    Note that the segment files must be specified in the correct order, but
  173.    the placement of the options is not important (they may be placed before,
  174.    after, or interspersed with the segment filenames).
  175.  
  176.    To extract the two files named "ReadMe" and "Help Text" from an archive
  177.    named "BBS.CPT" and store them in the current directory, use the following
  178.    command line:
  179.  
  180.    A> EXTRACT BBS.CPT -eREADME -e"help text"
  181.  
  182.    The capitalization of the filenames is ignored, but quotes are required
  183.    around "help text" since it contains space characters.  Note that no spaces
  184.    are allowed between an "e" or "d" option and the following filename.
  185.  
  186.    Options may be combined following a single "-" character;  however, if the
  187.    "e" or "d" options are combined with other options, they must be the last
  188.    option in the group.  Here is an example of a command line which specifies
  189.    the "overwrite" and "skip errors" options and extracts the resource forks of
  190.    all files in an archive named "FONTS.CPT" to a directory named
  191.    "MACFONTS\TEMP":
  192.  
  193.    A> EXTRACT FONTS -osrdMACFONTS\TEMP
  194.    
  195.  
  196. Limitations
  197.  
  198.    ExtractorPC has the following limitations:
  199.       o Archives with more than 800 files and folders cannot be expanded.
  200.       o Archives with more than 20 segments cannot be expanded.
  201.       o Encrypted files cannot be expanded.
  202.  
  203.  
  204. Problem Reports
  205.  
  206.    ExtractorPC was written by Bill Goodman.  You may report problems or send
  207.    suggestions to the author by US Mail at:
  208.  
  209.       Bill Goodman
  210.       Cyclos
  211.       PO Box 31417
  212.       San Francisco, CA 94131-0417
  213.       USA
  214.  
  215.    You may also use the following electronic mail addresses:
  216.  
  217.       Compuserve:  71101,204
  218.       Internet:    71101.204@compuserve.com
  219.       AppleLink:   CYCLOS
  220.