home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / useful / dist / util / arc / lharc / lharc.doc < prev    next >
Text File  |  1990-12-05  |  36KB  |  917 lines
  1. ________________________________________________________________________
  2. ------------------------------------------------------------------------
  3.  
  4.  
  5.                         LHARC        vers. 1.30
  6.  
  7.                         for the Commodore AMIGA
  8.          Compatible with version 1.13 of Lharc for MSDOS systems
  9.  
  10.  
  11.                             by Paolo Zibetti
  12.  
  13.           Fidonet 2:331/101.6
  14.           Internet/UUCP: Paolo.Zibetti@p6.f101.n331.z2.fidonet.org
  15.  
  16.  
  17.                  (assembler routines by  Paolo Toccaceli) 
  18.  
  19. ------------------------------------------------------------------------
  20.  IMPORTANT NOTICE:  This program is copyrighted by Paolo Zibetti, but can
  21.  be freely distributed, providing that the following rules are respected.
  22.  - No change is made to the program nor to the accompaning documentation
  23.  - The package is always distributed in its complete form consisting of 
  24.    (at least) the 4 files: "Lharc", "Lharc.doc", "Changes" and README.1st.
  25.  - Every form of distribution is allowed and encouraged, but no fee can 
  26.    be charged for this program exept for, possibly, the cost of magnetic 
  27.    media and/or disk duplication and shipping.
  28.  - Inclusion in PD software libraries such as Fish Disks is allowed, 
  29.    provided the fees charged for these disks are comparable with those
  30.    charged by Fred Fish.
  31.  - The program cannot be distributed in any commercial product without the 
  32.    written consent of the author.
  33.    Software developers interested in using Lharc for distributing thier
  34.    products should contact me to obtain my explicit permission (what I
  35.    generally ask in return is simply to receive a free copy of thier
  36.    products).
  37.  
  38.  By copying, distributing and/or using the program you indicate your 
  39.  acceptance of the above rules.
  40.  
  41.  Also remember that this program is supplied 'as is': the entire risk as
  42.  to the quality of the program is to the user. In no event will the author 
  43.  be liable for direct or indirect damage or loss resulting from the use
  44.  of this program.
  45. ------------------------------------------------------------------------
  46.  
  47. ________________________________________________________________________
  48. ------------------------------------------------------------------------
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  --- Introduction ---
  60.  
  61. Lharc is an archive program such as Arc and Zoo. It can store several
  62. files in one archive in a compressed form which is generally more
  63. efficent than that used by Arc and Zoo.  It also supplies all of the
  64. archive handling capabilities that an archive program should have.
  65. In particular it is able to store an entire directory tree
  66. (including empty directories) with one single command. This enables
  67. you, for example, to store an entire floppy-disk with a single
  68. command and the resulting archive is usually shorter than those
  69. prodeced by Warp or even LhWarp (see the -r switch). 
  70. Another important feature of Lharc is its ability to preserve the file
  71. attributes (see the -a switch) and filenotes (i.e. the comments that
  72. AmigaODS can associate to each file).
  73. Its only weakness is compression speed: Zoo 2.0, for example, is
  74. faster, but if compression efficency is more important for you than
  75. compression time you'll surely appreciate this progam. (anyway
  76. decompression is much faster than compression)
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  --- Before starting ---
  88.  
  89. Lharc is a 'pure' program, i.e. you can make it resident via the
  90. 'resident' Amigados command just like any other command found in the
  91. c: directory. Keeping Lharc resident will greatly facilitate users
  92. who make an heavy use of Lharc (especially those who don't have an
  93. hard disk).
  94. If you have just received Lharc, beware that some copy programs and
  95. some archivers (including the zoo archiver which is used for
  96. distribution of Lharc) don't preserve file attributes, so the 'p'
  97. flag may not be set for the Lharc executable and Amigados won't
  98. understand that Lharc is a pure program. If so, just type the
  99. following line at the CLI prompt:
  100.  
  101.  protect Lharc p add
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  --- How to use ---
  113.  
  114. Lharc is run from CLI with the following command line:
  115.  
  116.   Lharc [<switches>] <Command> <Archive> [<dest path>] [<file patterns>]
  117.  
  118. items in square brackets are optional.
  119.  
  120.  
  121.  
  122.  
  123. <Command> can be any of the following (case is not significant):
  124.  
  125.  
  126.   e,x  extract files from archive
  127.        Extracts files from archives. If you specify some file names
  128.        or patterns only those files satisfying the patterns are
  129.        extracted, otherwise all the files in the archive are
  130.        extracted.
  131.        While extracting files, Lharc checks if a file by the same
  132.        name already exsists in the destination directory and prompts 
  133.        you before overwriting the old file with the extracted one 
  134.        (unless you specified the -m switch)
  135.        By default, if the files have a path name stored in the archive, they 
  136.        are extracted with their path and needed directories
  137.        are automatically created; use the -x0 switch to ignore path names.
  138.        See below under '<dest path>' for a discussion on where the
  139.        extracted files are stored.
  140.  
  141.  
  142.   l    show archives contents
  143.        Displays the names of the files in an archive along with their
  144.        date, time, CRC, compression type, original lenght and
  145.        compressed lenght.
  146.        If the -x switch is specified file names are listed complete
  147.        with their path (if present in the archive), otherwise
  148.        only the name of the files is listed.
  149.        The 'l' command won't list the comments (filenotes) that may be
  150.        assiciated with a file: use the 'v' command to see them, too.
  151.  
  152.  
  153.   v    Same as 'l', but default is to display full pathnames: i.e.
  154.        the 'v' command is equivalent to the 'l' command with the -x switch;
  155.        on the other hand the 'l' command is equivalent to the 'v' command
  156.        with the -x0 switch. 
  157.        Moreover 'v' will also show any filenote (i.e. comment) 
  158.        associated with the files; filenotes, if present,
  159.        are listed on a separate line preceded by a colon
  160.        (i.e. in the same format used by the AmigaDOS 'list' command).
  161.  
  162.  
  163.   p    extract and print files to screen
  164.        same as 'e' and 'x', but extracted files are sent to stdout
  165.  
  166.  
  167.   t    test archive integrity
  168.        Checks CRCs and checksums to ensure that the archive is not
  169.        corrupted. Lharc will test all the files on the archive, one
  170.        after each other, printing "OK" to the right of the file names
  171.        which are OK and "WARNING: CRC check failed" to the right of 
  172.        file names that are corrupted. At the end of the test the
  173.        message "Operation successful" means that all the files tested 
  174.        were OK, while the message "Operation not totally successful"
  175.        means that some files in the archive were corrupted (so you
  176.        will know of a corrupted file even if the warning message
  177.        relating to that file has scrolled away on the screen) 
  178.  
  179.  
  180.   a    create archives or add to existing archives
  181.        Files are stored in alphabetical order, unless you change
  182.        this with the -S switch. Note however that sorting only
  183.        applies to the files beeing added in the current session,
  184.        i.e. if you add files to an existing archive containing
  185.        other files, the new files will be stored, in alphabetical
  186.        order, AT THE END of the archive: old and new files won't be
  187.        intermixed to preserve global alphabetical order.
  188.        If you try to archive a file and a file by the same name
  189.        already exists in the archive the file will not be added
  190.        and a message will be printed on the screen to inform you. 
  191.        By default only file names are stored in the archive, use the 
  192.        -x switch to store file names complete with their paths.
  193.        Also, by default file attributes are not stored, use the '-a'
  194.        switch to obtain this.
  195.  
  196.  
  197.   m    move files into archivs
  198.        Same as add, but deletes original files after archiving them
  199.  
  200.  
  201.   d    delete files from archives
  202.        You can delete from an archive a maximum of 150 files at a time,
  203.        if you find that they are too little, please let me know!  
  204.  
  205.  
  206.   u    update files in archives
  207.        Same as with the 'a' command.  However, if a file already 
  208.        exists in the archive, LHarc will check i