home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / utility / archiver / lzh201le / man.eng < prev    next >
Text File  |  1992-02-05  |  14KB  |  425 lines
  1.       User's Manual for High-Performance File-Compression Program
  2.  
  3.               LHarc Version 1.13c
  4.                 05/31/89
  5.  
  6.  
  7.        Copyright (c) Haruyasu Yoshizaki (Yoshi), 1988-89
  8.  
  9.  
  10. (This manual is dramtically shortend, use it as an "emergency-manual"
  11. if you recieived LHarc with no docs)
  12.  
  13. 1. How to Use It:
  14.  
  15.    Just type "LHarc" to see a concise help screen of the program's
  16.    command structure.
  17.  
  18.  
  19.    Command-line synopsis:
  20.    ======================
  21.  
  22.    LHarc [<command>] [{{/|-}{<switch>[-|+|2|<option>]}}...] <archive_name>
  23.      [{<drive_name>:}|{<home_directory_name>\}] [<path_name> ...]
  24.  
  25.    Only a single command can be specified on the command line, but a
  26.    group of switches can be specified together after the '/' or '-'
  27.    delimiter.  You may place switch(es) anywhere following the command.
  28.  
  29.    Hitting 'Ctrl-Break' or 'Ctrl-C' at any time will abort LHarc's
  30.    current operation and return you to the DOS prompt.
  31.  
  32.    Commands:
  33.    =========
  34.  
  35.    a (Add files to archive)
  36.  
  37.      LHarc a ARCHIVE.LZH file1.ext
  38.  
  39.     Adds 'file1.ext' to 'ARCHIVE.LZH'.  If 'ARCHIVE.LZH' does
  40.     not exist, then LHarc will create it.  If a file with the
  41.     name 'file1.ext' already exists in the archive, LHarc will
  42.     replace it with the specified file.
  43.  
  44.    u (Update files to archive)
  45.  
  46.      LHarc u ARCHIVE.LZH file1.ext
  47.  
  48.     Adds 'file1.ext' to 'ARCHIVE.LZH', the same as with the 'a'
  49.     command.  However, if 'file1.ext' already exists in the
  50.     archive, LHarc will check its time stamp and will keep the
  51.     newer one and ignore the older one.  (Use the /c switch to
  52.     tell LHarc to skip this time-stamp comparison.)
  53.  
  54.    m (Move new files into archive)
  55.  
  56.      LHarc m ARCHIVE.LZH file1.ext
  57.  
  58.     is equivalent to
  59.  
  60.      LHarc u ARCHIVE.LZH file1.ext
  61.      DEL file1.ext
  62.  
  63.     Beware the fact that the second line is implicit.  You might
  64.     lose 'file1.ext' forever.
  65.  
  66.    f (Freshen files in archive)
  67.  
  68.      LHarc f ARCHIVE.LZH file1.ext
  69.  
  70.     Replaces 'file1.ext' in 'ARCHIVE.LZH' with the newer one
  71.     only if a file with this name already exists in the archive.
  72.     Otherwise, no action is taken.    (Use the /c switch to tell
  73.     LHarc to skip this time-stamp comparison.)
  74.  
  75.    e or x (EXtract files from archive)
  76.  
  77.      LHarc e ARCHIVE.LZH d:\temp\
  78.  
  79.     Extracts all the files from 'ARCHIVE.LZH
  80.     directory \temp\ on drive D:.  
  81.  
  82.      LHarc e ARCHIVE.LZH file1.ext
  83.  
  84.     Extracts only 'file1.ext' from 'ARCHIVE.LZH'.  If a file
  85.     with the name 'file1.ext' exists in the home directory,
  86.     LHarc will compare their time stamps and if the existing
  87.     file is older, then LHarc will prompt you whether to
  88.     overwrite it.  (Use the /c switch to tell LHarc to skip this
  89.     time-stamp comparison.)
  90.  
  91.  
  92.    p (disPlay files in archive)
  93.  
  94.      LHarc p ARCHIVE.LZH file1.ext
  95.  
  96.     Extracts 'file1.ext' from 'ARCHIVE.LZH' and redirects it to
  97.     standard output.
  98.  
  99.  
  100.    d (Delete files from archive)
  101.  
  102.      LHarc d ARCHIVE.LZH file1.ext
  103.  
  104.     Deletes 'file1.ext' from 'ARCHIVE.LZH'.
  105.  
  106.    l (List files in archive)
  107.  
  108.      LHarc l ARCHIVE.LZH
  109.  
  110.     Lists information about all the files in 'ARCHIVE.LZH':
  111.     name, original size, stored size, etc. Each file takes one
  112.     line of output.  A '+' before a file name indicates that a
  113.     directory name is stored with the file name. 
  114.  
  115.    v (View list of files in archive)
  116.  
  117.      LHarc v ARCHIVE.LZH
  118.  
  119.     Lists information about all the files in 'ARCHIVE.LZH',
  120.     except that each listing takes two lines: the first for the
  121.     full path name and the second for the rest of the
  122.     information.  
  123.  
  124.    t (Test integrity of archive)
  125.  
  126.      LHarc t ARCHIVE.LZH
  127.  
  128.     Tests the integrity of 'ARCHIVE.LZH' by running a CRC check
  129.     on each file and comparing the result against the file's
  130.     stored CRC value.
  131.  
  132.  
  133.      LHarc ARCHIVE.LZH
  134.  
  135.     Acts exactly the same as the 'x' command.  This optional
  136.     action is temporary.  Don't count on it in future versions.
  137.  
  138.    Switches:
  139.    =========
  140.  
  141.    Specify switch(es) following the switch delimiter '/' or '-'.  If
  142.    you want to specify more than one switch, type characters
  143.    continuously without any intervening spaces, like "/rx-we:\work" or
  144.    "/cxvless".    When the 'v' and 'w' switches are used with other
  145.    switches, they must be specified at the end of a sequence, as shown
  146.    in the above examples.
  147.  
  148.    You may place a '+' or '-' sign after switches, with the following
  149.    meanings: '+' turns the switch on and '-' turns the switch off.
  150.    The '2' creates a special option for the /r and /v switches (see
  151.    below).  If you just specify /<switch> without '+' or '-', then
  152.    <switch> will be toggled from 'on' to 'off' or vice versa, e.g., to
  153.    override any switch set in an environment variable (see below).
  154.  
  155.    NOTE:  Use only lowercase letters for switches.  Capital letters
  156.       are reserved for future use.
  157.  
  158.  
  159.      /x[-|+] (allow eXtended file names)
  160.  
  161.     By default, LHarc stores only the file names of archived
  162.     files and disregards the names of the directory(s) in which
  163.     they reside.  This switch tells LHarc to extend all file
  164.     names with directory names and to extract archived files
  165.     together with their stored directory names.
  166.  
  167.  
  168.      /p[-|+] (distinguish full Path names)
  169.  
  170.     By default, LHarc disregards directory names when extracting
  171.     files.    This switch tells LHarc to distinguish files by full
  172.     path name during un-archiving.
  173.  
  174.  
  175.      /c[-|+] (skip time-stamp Comparison)
  176.  
  177.      LHarc [e|f|u|x] /c ARCHIVE.LZH [file1.ext file2.ext ...]
  178.  
  179.     If a file with the same name is to be created, LHarc will
  180.     default to comparing the time stamp of each pair of files,
  181.     and so some files will be overwritten and some just ignored.
  182.     This switch tells LHarc to overwrite any existing files with
  183.     extracted ones with the same name.
  184.  
  185.  
  186.      /m[-|+] (no Message for query)
  187.  
  188.      LHarc [<command>] /m ARCHIVE.LZH [file1.ext file2.ext ...]
  189.  
  190.     By default, before operations that alter files or
  191.     directories, LHarc will query you with messages like
  192.     "Overwrite? [Y/N]".  This switch suppresses these messages
  193.     and tells LHarc to proceed as if "y" is typed in.
  194.  
  195.  
  196.      /a[-|+] (allow any Attribute of files)
  197.  
  198.      LHarc a /a ARCHIVE.LZH file1.arc
  199.  
  200.     adds 'file1.arc' to 'ARCHIVE.LZH'.
  201.  
  202.     By default, LHarc will not archive files with the hidden,
  203.     read-only or system attribute.    This switch tells LHarc
  204.     also to archive files with these attributes.
  205.  
  206.  
  207.      /r[-|+|2] (Recursively collect files)
  208.  
  209.  
  210.      LHarc has three modes of collecting the files to be archived:
  211.  
  212.     (a) specified file(s):    /r-
  213.  
  214.         LHarc a /r- ARCHIVE.LZH file1.ext [file2.ext ...]
  215.  
  216.          Adds to 'ARCHIVE.LZH' only the specified files
  217.          (default mode).
  218.  
  219.     (b) across directories:  /r or /r+
  220.  
  221.         LHarc a /r ARCHIVE.LZH *.c
  222.  
  223.          Adds to 'ARCHIVE.LZH' all the files with
  224.          extension .C on the current drive, starting
  225.          from the current directory.  LHarc will store
  226.          all file names extended with directory names.
  227.          Use this switch to archive all versions of a
  228.          file or all files of a certain type.
  229.  
  230.     (c) specified directory(s):  /r2
  231.  
  232.         LHarc a /r2 ARCHIVE.LZH \doc
  233.  
  234.          Adds to 'ARCHIVE.LZH' all the files in the
  235.          directory specified by the path \doc and its
  236.          branches, similar to the Unix -r option.  Use
  237.          this switch to archive complete directories.
  238.  
  239.     The /r and /r2 switches set the /x switch simultaneously.
  240.     You may have to toggle the /x switch off (with /x-) after
  241.     using /r or /r2.  The /x- switch tells LHarc to disregard
  242.     stored directory names.
  243.  
  244.  
  245.      /w[-|+|<directory_name>] (set Working directory)
  246.  
  247.      LHarc a /w[d:\temp] ARCHIVE.LZH [file1.ext file2.ext ...]
  248.  
  249.     Creates all the temporary files for 'ARCHIVE.LZH' in the
  250.     directory \temp\ on drive D:.  If no directory name is
  251.     specified with this switch, then the current directory
  252.     becomes the working directory and all the temporary files
  253.     created in the process of archiving will reside in this
  254.     directory and be deleted afterward.
  255.  
  256.      Use the /w switch when
  257.  
  258.     (1) you have no room in the directory where the archive is,
  259.         or
  260.     (2) you want your work done silently and swiftly on a RAM
  261.         disk.
  262.  
  263.     This switch overrides the working directory that may be
  264.     specified in an environment variable (see below).
  265.  
  266.  
  267.      /v[-|+|2|<utility_name>] (View file by another utility)
  268.  
  269.      LHarc p /v ARCHIVE.LZH file1.ext
  270.  
  271.     Extracts 'file1.ext' from 'ARCHIVE.LZH' and invokes the
  272.     default utility LESS for formatted display to standard
  273.     output.
  274.  
  275.     LHarc first creates an un-archived file 'LHARC.TMP' and then
  276.     invokes the specified utility, usually a page formatter like
  277.     LIST.PRG or SEE.PRG.  
  278.  
  279.      /n[-|+] (No Indicator)
  280.  
  281.     Suppress progress display oooo... in the process of
  282.     archiving and de-archiving.  The display is on the standard
  283.     error stream so that the dsiplay is on even in the process
  284.     of redirection.
  285.  
  286.      /t[-|+] (Time Stamp)
  287.  
  288.     Update the time stamps of Archive to the newest file in the
  289.     archive, effective with switches (a,u,m,f,d).
  290.  
  291.      /l         (Generate Larc-style-archive)
  292.  
  293.     The file is compressed without Huffman, the code will be about
  294.         5% longer than a normal 1.13-archiv but the compression and 
  295.      decompression is much faster. This is the format used in PFXPAK.
  296.     PFXPAK and Larclib are able to decode this type of files at a 
  297.     rate of about 100KB per second.
  298.  
  299.      /o      (Generate LHarc 1.13-style-archvie)
  300.  
  301.     Using this switch tells LHarc to use compression-method used in 
  302.     LHarc 1.13. Use this switch, if the archive may be extracted on
  303.     other machines than atari st or ibm pc.
  304.  
  305.      /k      (Generate compatible headers)
  306.  
  307.     LHarc 2.x automatically generates an extended-header of size 
  308.     Zero. Some versions of LHarc may not be able to extract files
  309.     with extended headers. Using -ok will gernerate full compatible
  310.     archives.
  311.  
  312.      /u     (Store without compression)
  313.  
  314.     The files are stored to the archiv without compression.
  315.     
  316.  
  317.    Home directory name (drive name):
  318.    =================================
  319.  
  320.    If you specify a home directory name, then LHarc will refer to that
  321.    directory as if it is the current directory.  Specify a home
  322.    directory name ending with either '\' or ':'.  All files will be
  323.    archived without storing this directory name unless you also use the
  324.    /r or /x switch.
  325.  
  326.  
  327.    File name (path name):
  328.    ======================
  329.  
  330.    The file names or path names of files to be archived must be
  331.    specified or else LHarc will assume *.* with no directory names.
  332.    The wildcards '*' and '?' behave exactly as in DOS.    You cannot use
  333.    them to specify directories except with the /r2 switch, similar to
  334.    the Unix -r option for cp, mv and rm.
  335.  
  336.  
  337. 2. Setting Switches in an Environment Variable
  338.  
  339.    You may set any of LHarc's default switches with the environment
  340.    variable 'LHARC':
  341.  
  342.      SET LHARC=/we: /r2
  343.  
  344.     will set drive E: as the working directory and archive all
  345.     files in directory mode.
  346.  
  347.    You may also specify LHarc's working directory with the environment
  348.    variable 'TMP':
  349.  
  350.      SET TMP=E:
  351.  
  352.     but the /w switch will override this setting.
  353.  
  354.  
  355. 5. Result Codes
  356.  
  357.    LHarc returns the following result codes to the parent process:
  358.  
  359.     0   Normally finished.
  360.  
  361.     1   Process finished with nonexistent file names ignored
  362.         during archiving or CRC error occurred during
  363.         un-archiving.
  364.  
  365.     2   Process terminated by fatal error; no archive created
  366.         or files moved.
  367.  
  368.     3   Unable to write temporary files into the archive.  Work
  369.         file renamed to 'LHARC.)2(' and original archive
  370.         deleted.  Try renaming LHARC.)2( as your archive,
  371.         although it might be damaged.
  372.  
  373.  
  374. 6. Temporary Files
  375.  
  376.     LHARC.)1(   Original archive, renamed.
  377.     LHARC.)2(   Work file used to create new archive.
  378.     LHARC.TMP   Work file created for viewing by another utility.
  379.  
  380.    If a file with one of these file names already exists in the working
  381.    directory, then the behavior of LHarc is unpredictable.
  382.  
  383. 7. My Distribution Policy
  384.  
  385.    Under the following conditions, you may freely copy and distribute
  386.    this software:
  387.  
  388.    1. Under all circumstances, "Copyright by Haruyasu Yoshizaki"
  389.       must be attached to the copy.
  390.  
  391.    2. The manual LHarc.MAN or its hardcopy should go together with the
  392.       software. (Not this short version!)
  393.  
  394.    3. You may modify the program, but in that case, you must distri-
  395.       bute the complete source code for the program, including your
  396.       specific contributions and you must make it clear that you
  397.       have made such modifications.
  398.  
  399.    4. You must try to distribute the latest version available.
  400.  
  401.    5. I assume no warranty for any claim of damage you may sustain
  402.       by using this software.
  403.  
  404.    6. I have no obligation to revise the program to correct any
  405.       fault in this software.
  406.  
  407.    7. For any commercial use of this software, I add the following:
  408.  
  409.       a. The entire software made incorporating this program should
  410.      not be copy protected in the sense that the DISKCOPY
  411.      program of MS-DOS makes an imperfect copy.
  412.  
  413.       b. Every part of the package should print the name "LHarc" and
  414.      the copyright banner.
  415.  
  416.       c. The distribution policy of this software should be printed
  417.      either in the manual, in the package or on the disk label.
  418.  
  419.      Comment:  If a commercial package or a shareware
  420.            product uses LHarc with self-extracting SFX
  421.            form for the distribution, then the Copy-
  422.            right statement must appear with SFX header.
  423.            I consider this as a claim of LHarc's Banner.
  424.  
  425.