home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / archiver / lharc102 / lharc.doc < prev    next >
Text File  |  1990-02-27  |  8KB  |  238 lines
  1.  
  2.                   LHarc -  Atari ST Version 1.02
  3.                              02/27/90
  4.  
  5.                            INTRODUCTION
  6. LHarc was originally written for use on MSDOS systems by  Haruyasu 
  7. Yoshizaki.   The  UN*X  version of LHarc was  written  by  Yooichi 
  8. Tagawa,  and  it is his version 0.03 that I used for the "initial" 
  9. Atari  ST port.   I say "initial" because I have changed the  user 
  10. commands so that they are compatible with the PC version  wherever 
  11. possible.   I have also added some commands that the UN*X  version 
  12. was  lacking,  but  I  thought were  necessary,  such  as  archive 
  13. testing.
  14.  
  15.  
  16.                             DISCLAIMER
  17. I make no warranty regarding the use of this version of LHarc. Use 
  18. this program only if you are willing to assume all  responsibility 
  19. for any damage you may sustain using it. 
  20.  
  21.                               USING LHARC
  22. Command-line synopsis:
  23.  
  24. lharc {<command>}[<options>] archive [files or directories]
  25.  
  26. You must have one command and 0 or more options on each command-line.
  27.  
  28.                                COMMANDS
  29.  
  30. a - Add file to archive
  31.  
  32. Ex. lharc a archive.lzh file.ext
  33.  
  34.      Adds  'file.ext' to 'archive.lzh.  If 'archive.lzh' does  not 
  35.      exist,  then  LHarc  creates it.   If a file  with  the  name 
  36.      'file1.ext'  already exists in the archive, then  LHarc  will 
  37.      replace it with the specified file.
  38.  
  39. ------------------------------------------------------------------
  40. u - Update files to archive
  41.  
  42. Ex. lharc u archive.lzh file.ext
  43.  
  44.      Adds  'file.ext' to 'archive.lzh',  the same as with the  'a' 
  45.      command.   However,  if  'file.ext'  already  exists  in  the 
  46.      archive,  LHarc will check it's time stamp. and will keep the 
  47.      newer one and ignore the older one.
  48.  
  49. ------------------------------------------------------------------
  50. c - reConstruct archive
  51.  
  52. Ex. lharc c archive.lzh file.ext
  53.  
  54.      This is the same as the 'a' commands except for the fact that 
  55.      if 'archive.lzh' already exists, it will be deleted, then re-
  56.      created  with  'file.ext'  becoming  the  only  file  in  the 
  57.      archive.   NOTE:  This command is not available in the MS-DOS 
  58.      version.
  59.  
  60. ------------------------------------------------------------------
  61. m - Move files into archive
  62.  
  63. Ex. lharc m archive.lzh file.ext
  64.  
  65.      This  is  the  same as the 'u'  command  but  after  updating 
  66.      'archive.lzh'  with 'file.ext',  'file.ext' will be  deleted.  
  67.      Be careful when using this command.
  68.  
  69. ------------------------------------------------------------------
  70. e or x - Extract files from archive
  71.  
  72. Ex. lharc x archive.lzh 
  73.  
  74.      Extracts all the files from 'archive.lzh'.
  75.  
  76. Ex. lharc x archive.lzh file.ext
  77.  
  78.      Extracts  only 'file.ext' from 'archive.lzh'.   If  the  name 
  79.      'file.ext' already exists then LHarc will ask you if you wish 
  80.      to overwrite the existing 'file.ext'.
  81.  
  82. Ex. lharc x archive.lzs file.ext
  83.  
  84.      Extracts  'file.ext'  from an .LZS file  archived  with  Larc 
  85.      3.xx.   NOTE: This is an untested feature as I could not find 
  86.      an .LZS file to test it with.
  87.  
  88. ------------------------------------------------------------------
  89. p - disPlay files in archive
  90.  
  91. Ex. lharc p archive.lzh file.ext
  92.  
  93.      Extract  'file.ext'  from archive.lzh' and  redirects  it  to 
  94.      standard output.
  95.  
  96. ------------------------------------------------------------------
  97. d - Delete a file from archive
  98.  
  99. Ex. lharc d archive.lzh file.ext
  100.  
  101.      Deletes 'file.ext' from 'archive.lzh'.
  102.  
  103. ------------------------------------------------------------------
  104. l or v - List files in archive
  105.  
  106. Ex. lharc l archive.lzh
  107.  
  108.      Lists information about all the files in  'archive.lzh'.  The 
  109.      'v'  command  gives  a more detailed  listing  than  the  'l' 
  110.      command.
  111.  
  112. ------------------------------------------------------------------
  113. t - Test archive integrity
  114.  
  115. Ex. lharc t archive.lzh
  116.  
  117.      Will  check the integrity of the archives file  'archive.lzh' 
  118.      by CRC check.
  119.  
  120. ------------------------------------------------------------------
  121.  
  122.                                 OPTIONS
  123.  
  124. NOTE:  Most  of  the options are not consistent  with  the  MS-DOS 
  125.        version.
  126.  
  127. b - Keep a backup of an old archive
  128.  
  129. Ex. lharc ab archive.lzh file.ext
  130.  
  131.      If  'archive.lzh' is an existing archive then make  a  backup 
  132.      copy  of  it before adding 'file.ext'.   The backup  will  be 
  133.      renamed to 'archive.bak'.
  134.  
  135. ------------------------------------------------------------------
  136. f - Force overwrite at extract
  137.  
  138. Ex. lharc xf archive.lzh file.ext
  139.  
  140.      When  extracting,   if  'file.ext'  already  exists  it  will 
  141.      automatically be overwritten.
  142.  
  143. ------------------------------------------------------------------
  144. h - Hold screen
  145.  
  146. Ex. lharc vh archive.lzh
  147.  
  148.      This  will cause the prompt "Hit any key to  continue..."  to 
  149.      appear  when any command is completed.   This is useful  when 
  150.      running LHarc from the desktop so that you have time to  read 
  151.      the screen.
  152.  
  153. ------------------------------------------------------------------ 
  154. q - Quiet mode
  155.  
  156.      Use this option if you want minimal onscreen messages.
  157.  
  158. ------------------------------------------------------------------
  159. s - Files are text files.
  160.  
  161. Ex. lharc as archive.lzh file.ext
  162.  
  163.      If 'file.ext' is known to be a text file and you specify this 
  164.      option  then  LHarc will do LF -> LF/CR conversion  and  vice 
  165.      versa.
  166.  
  167. ------------------------------------------------------------------
  168. z - Distinguish full path names / Ignore full path names
  169.  
  170. Ex. lharc xz archive.lzh
  171.  
  172.      This will cause LHarc to either use the full path names or 
  173.      ignore  them,  depending upon you environment.   If  you  are 
  174.      running LHarc from the desktop or a graphical shell,  such as 
  175.      ArcShell,  then  the 'z' option will cause LHarc to  use  the 
  176.      full path names when adding or extracting files.   If you are 
  177.      running from a CLI shell,  such as Gulam, the 'z' option will 
  178.      cause LHarc to ignore full path names.
  179. ------------------------------------------------------------------
  180.  
  181.                           OTHER FEATURES
  182.  
  183.      - LHarc supports the environmental  variable  'ARCTEMP'.   If 
  184.        the  variable  is set  then LHarc will write  all  of  it's 
  185.        temporary files to the specified directory.
  186.        Ex.  If 'ARCTEMP' is set to 'J:\tmp\' LHarc will write it's 
  187.        temporary files to subdirectory \tmp\ on drive J:.
  188.  
  189.  
  190.      - LHarc  accepts both slashes  and backslashes  as  directory 
  191.        separators.  This is inherent in the GCC libraries.
  192.  
  193.      - LHarc can manipulate MS-DOS self-extracting LZH files  with 
  194.        the extenders .COM and .EXE.
  195.  
  196.      - The only limits to the  number of files per archive  should 
  197.        be the  amount of memory you have  and the amount  of  disk 
  198.        space available.   NOTE:  The most files I have used during 
  199.        tests was 517.
  200.  
  201.                         INCOMPATIBILITIES 
  202.  
  203.      - MS-DOS version cannot extract ST archives that include full 
  204.        path names.   If you are going to use you archives in  both 
  205.        the ST and MS-DOS worlds, then do not use path names!
  206.  
  207.  
  208.                          ACKNOWLEDGMENTS 
  209.  
  210. This  port of LHarc was done using GCC V1.37.   I don't think  any 
  211. other C compiler available for the Atari ST can match the code  it 
  212. produces, speedwise.
  213.  
  214. Thanks  to Jwahar Bammi and Eric Smith for all the work  and  long 
  215. hours  they've  put in on the GNU C compiler and  it's  libraries.  
  216.  
  217. Thanks to Haruyasu Yoshizaki for developing LHarc-PC and releasing 
  218. it into the public domain.
  219.  
  220. Thanks to Yooichi Tagawa for releasing his UN*X port of LHarc so I 
  221. could port it with minimal difficulties.  No byte swapping!
  222.  
  223.  
  224.  
  225. Please send all comments, suggestions, and bug reports to:
  226.  
  227. Bill Shroka
  228. bjsjr@NCoast.ORG
  229. ncoast!bjsjr@hal.cwru.edu
  230. uunet!hal.cwru.edu!ncoast!bjsjr
  231. GEnie: B.SHROKA
  232.  
  233.  
  234. Some  portions of this documentation are taken directly  from  the 
  235. MS-DOS LHarc manual.
  236.  
  237.  
  238.