home *** CD-ROM | disk | FTP | other *** search
/ Supremacy 1 / Supremacy-1.iso / DEMOS / C-D / DOCDISK.ZIP / UTILS.DOC / UNLZH.DOC < prev   
Text File  |  1992-03-19  |  16KB  |  330 lines

  1.  
  2. UNLZH version 1.7 - A program for extracting .LZH archive files.
  3.  
  4. UNLZH combines an easy to use, GEM based interface with high speed
  5. extraction routines, to give you a much simpler and much faster way to
  6. extract LZH archives.  It is a self contained program - you do not need
  7. to have LHARC or any 'shell'.  It is written in 100% Assembly language,
  8. and extracts approximately four times faster than LHARC.
  9.  
  10. UNLZH can search past damaged sections of an archive, and should be able
  11. to extract the rest of the files.
  12.  
  13. UNLZH can also extract multiple archives at once, and place the contents
  14. in individual folders.
  15.  
  16. How to Use the Program:
  17. -----------------------
  18.  
  19. UNLZH will start with a menu screen that contains configuration options,
  20. and all the main functions.  In the upper part of the menu are two program
  21. options that should be set up before selecting any of the function buttons
  22. in the lower part.
  23.  
  24. The first option, Create Folders, can be used if you want the program to
  25. create a folder with the same name as the archive file, and place all the
  26. extracted contents within it.  If you want to extract directly to the
  27. destination path, select 'No' for the Create Folders option.
  28.  
  29. When the second option, Overwrite Files, is set to 'No', the program will
  30. prompt you if one of the files to be extracted already exists.  (Similar
  31. to the warning the GEM desktop gives you when you try to copy a file that
  32. already exists).  Selecting 'Yes' for this option will bypass the warning
  33. prompt, and overwrite any files that may have already existed.
  34.  
  35. Program Functions:
  36. ------------------
  37.  
  38. - Extract -
  39.  
  40. The first, and default function is to Extract all.  This will prompt you
  41. for an input archive file, then a destination path, and then extract all
  42. the files from the archive.  If the Create Folders option is turned on,
  43. a folder will be created at the destination path, and the files will be
  44. extracted into it.  If a folder by that name already exists, the program
  45. will extract into the already existing folder.
  46.  
  47. To extract multiple archives at once, just enter an '*' for the input
  48. filename.  UNLZH will then extract all of the archives in that directory.
  49. You should have the Create Folders option turned on, so that the archives
  50. will extract into separate folders.
  51.  
  52. - W/Query -
  53.  
  54. Extract With Query operates the same as the full Extract, except that
  55. after selecting the input archive file, another menu will come up which
  56. displays all of the files contained in the archive.  You may click on
  57. individual files to select them, or hold the left mouse button down and
  58. drag the pointer over a group of files.  Files selected for extraction are
  59. indicated by having an '*' placed in front of the file name.  Files may
  60. also be deselected in the same way.  When you have selected all the
  61. desired files, click on the Extract button.  The ALL button is a short
  62. cut, in case you decide you want all the files after all, and don't want
  63. to select them all manually.  You can also click on Quit, which will
  64. return you to the initial menu.
  65.  
  66.  
  67. If the archive file has been damaged, some of the selections may display as
  68. '- Bad Header -'.  These sections cannot be extracted, however UNLZH will
  69. search the rest of the archive to find as many good files as possible.
  70.  
  71. - To Screen -
  72.  
  73. Extract to Screen also displays a menu of the archive contents.  Some files
  74. may already be selected for extraction.  Any file beginning with READ, or
  75. having the extension .TXT, .DOC, or .ASC, will be marked.  Also, if there
  76. is only one file in the archive, it will be marked to extract.  If you wish
  77. to extract the pre-selected files, you can immediately select the Screen or
  78. Printer option at the bottom of the menu.  Otherwise, you may manually
  79. select which file(s) you want to look at in the same manner as described for
  80. Extract with Query.
  81.  
  82. A maximum of 3 files will be marked, except in cases where the archive
  83. contains all text files, in which case none of the files will be pre-marked.
  84.  
  85. Screen listings will pause every 24 lines.  (Or more if you are using a
  86. larger screen).  There are many options to control the screen listing:
  87.  
  88. Left Mouse Button - Continue listing one line at a time
  89. Right Mouse Button - Reverse scroll the listing, one line at a time
  90. Both Buttons - Abort listing
  91.  
  92. 'Return' - Display one line at a time
  93. 'Down Arrow' or 'Space Bar' - Display one screen at a time
  94. 'Up Arrow' - Back up to the previous screen
  95. 'Shift' & 'Down Arrow' - Jump 4 screens forward
  96. 'Shift' & 'Up Arrow' - Jump 4 screens backward
  97. 'Home' - Return to the top of the file
  98. 'S' - Enter Search and Move menu:
  99.  
  100.       To perform a search, enter a phrase to search for, and select whether
  101.       the program should 'Match', or 'Ignore' differences in upper/lower
  102.       case.  Then click on either 'Search' or 'Next' to begin searching.
  103.       (You may also press the 'Return' key for the Next function).
  104.       'Search' will start at the top of the file, and 'Next' will start at
  105.       the current location.  The program will display the next line that
  106.       contains the search phrase.  If no match was found, the display will
  107.       be in the same place, and the Bell will sound.
  108.  
  109.       The other buttons allow you to jump directly to one of five positions.
  110.       'Top' jumps to the top of the file.  (Same as Home)
  111.       '1/4' jumps to a position one quarter of the way through the file
  112.       '1/2' jumps to half way through the file
  113.       '3/4' jumps three quarters of the way through
  114.       'End' jumps to the end of the file
  115.  
  116. 'N' - Display the 'Next' match, using the current search phrase
  117. 'P' - Send a block of text to the Printer:
  118.  
  119.       The first 'P' will mark the top line of the current screen as the top
  120.       of the block.  Then move down to the end of the area you wish to print,
  121.       and press 'P' again.  This will send all of the text from your first
  122.       mark, to the bottom line of the ending screen, to the printer.
  123.  
  124. 'D' - Send a block of text to a disk file.  This works the same as the 'P'
  125.       function, except you will get a GEM file selector to enter a name for
  126.       the text file to write the block to.
  127.  
  128. Press 'ESC' to abort either screen or printer listings.
  129.  
  130. If multiple files were selected for extraction, Abort will progress to the
  131. next file.  This, combined with the search capabitities, allows you to
  132. search multiple files very easily.
  133.  
  134. Notes: In low memory situations, where there is not enough room to store
  135. the entire extracted file, the process is done in segments, and there are a
  136. few differences in the way the program responds.
  137.  
  138. Backing up the display is limited to how much of the extracted file is still
  139. in memory.  You may find a point where you can't back up any further.  This
  140. is because the data before this point has been overwritten.  This
  141. restriction does not occur with the Home, Search, and Jump functions, and
  142. they may be used to get back to earlier sections of the file.
  143.  
  144. After a search where a match is not found, the program will try to return
  145. to the previous location.  If that spot is no longer in memory, the program
  146. will jump to the top of the file.
  147.  
  148. When using the Print Block feature, you may be scrolling the file across one
  149. of the segment boundaries.  If this happens the program will immediately
  150. send all the data so far, out to the printer.  The scrolling process will be
  151. paused until the data has been sent.  Afterwards, you can continue scrolling
  152. to the desired end position, and press 'P' to print the rest of the data.
  153.  
  154. Again, unless you operate the program in low memory situations, and/or
  155. extract large text files, you will not see any of these behaviors.
  156.  
  157. - Test -
  158.  
  159. The Test function is used to test the files in an archive without actually
  160. extracting any of them.  It will display 'Okay' after each valid file, and
  161. report any problems found in the archive.  It operates like Extract with
  162. Query, but does not ask you for a destination path, (as it does not write
  163. out any extracted files).
  164.  
  165. - View -
  166.  
  167. View allows you to look at all the files in an archive.  It will ask for
  168. an input archive file, and then display an options menu.  You should first
  169. select either Verbose or Short format.  Short will list only the filenames,
  170. original sizes, and any comments the archive contains.  The Verbose form
  171. lists the following information about all of the files.
  172.  
  173. Filename:  The name of the original file.
  174. Actual:    The size of the original file.
  175. Packed:    The size of the compressed file.
  176. Ratio:     The compressed file size as compared to the original.
  177. Time/Date: The time and date when the file was last modified.
  178. Attr:      The following letters will be displayed if the corresponding
  179.            file attribute is set:
  180.            r - File is set to Read Only
  181.            h - File is hidden from directories
  182.            s - System file
  183.            a - Archive bit.
  184. Methd:     The method used in storing the file.  Either '-lh1-' for a
  185.            compressed file, or '-lh0-' for uncompressed
  186. CRC        The CRC calculation of file.  This value is recalculated
  187.            whenever the file is extracted, to test if the file is Okay.
  188.  
  189. You can also select whether the output will be displayed on the screen,
  190. sent to the printer, or sent to a disk file.
  191.  
  192. The screen display will pause every 24 lines.  You may press 'Space Bar' to
  193. continue, 'Return' or Left Mouse Button to list one line at a time, 'Home'
  194. to return to the top of the list, and 'ESC' or Both Mouse Buttons to abort.
  195. Backing up is not supported.
  196.  
  197. If you enter '*' for the input filename, UNLZH will create a listing of all
  198. the archives in the directory, separated by the names of the archives
  199. themselves.
  200.  
  201. - Quit -
  202.  
  203. Quit will exit to the desktop.
  204.  
  205.  
  206. Saving the Configuration:
  207. -------------------------
  208.  
  209. The 'Save Configuration' button will save the current settings for all of
  210. the program options, (including Short/Verbose listing and Match/Ignore
  211. cases), plus the input and output path names that were last used.  The
  212. information will be written directly into the program file itself.  If
  213. UNLZH17.PRG cannot be found on the default directory, the program will ask
  214. you to enter its location using the file selector.
  215.  
  216. Do not attempt to save a configuration into an UNLZH program file that has
  217. been modified in any way.  If you have used a compression program such as
  218. 'PACK' on the UNLZH17.PRG file, you MUST uncompress the file before saving
  219. any configurations.
  220.  
  221. The Overwrite Warning Message:
  222. ------------------------------
  223.  
  224. Anytime UNLZH finds that an extracted file already exists at the
  225. destination, it will display a warning message with several choices.
  226. (Unless you have the program option Overwrite Files set to 'Yes').
  227.  
  228. You may press the 'Return' key, or click on 'Extract' to overwrite the
  229. file.  You may also change the name of the extracted file to something
  230. else, and press return.
  231.  
  232. The 'Skip' button will skip the current file without extracting it, and
  233. continue with the rest of the archive.  The file will also be skipped if
  234. you press the 'Esc' key to erase the name, and then press 'Return'.
  235.  
  236. The 'All' button will extract all of the files in the current archive
  237. without any more warning prompts.  When the archive has been extracted
  238. completely, the warning prompt will be active again in case you are doing
  239. multiple archives.
  240.  
  241. The 'Quit' button will skip the rest of the files in the current archive.
  242. If you are extracting multiple archives, it will go on to the next one.
  243. Otherwise, 'Quit' will return to the main menu.
  244.  
  245. Files set to Read-Only  (Protected Files)
  246. ----------------------
  247.  
  248. You will also get a warning message if the existing file is set to Read
  249. Only.  The prompt will indicate that the file is protected, and give you
  250. the same choices as the File Overwrite warning.  Note: The Read Only
  251. warning will always be active, regardless of the setting for the Overwrite
  252. Files option.
  253.  
  254. UNLZH as a GEM application:
  255. ---------------------------
  256.  
  257. In addition to running normally from the desktop, UNLZH can be installed
  258. as a GEM application with a document type LZH.  This allows you to double-
  259. click on any .LZH archive, and automatically load in the UNLZH program.
  260. You can still select options from the main menu.  When you select a
  261. program function, you will not be asked for an input file.  Instead, UNLZH
  262. will use the .LZH file you double-clicked on as its input.  Also, when the
  263. operation is completed, the program will exit to the desktop, instead of
  264. returning to the main menu.
  265.  
  266. To Install:  (From the GEM Desktop)
  267. -----------
  268.  
  269. If you have previously installed an application for .LZH files, you will
  270. need to remove it.  Click once on the previous program to highlight it.
  271. Select 'Install Application' from the Options drop down menu.  Then click
  272. on the Remove button.
  273.  
  274. To install UNLZH, click once on UNLZH17.PRG, select 'Install Application'
  275. from the drop down menu, enter 'LZH' as the document type, and then click
  276. on the Install button.
  277.  
  278. You should then save the desktop, also using the options drop down menu.
  279.  
  280. Command Lines:
  281. --------------
  282.  
  283. There is limited support for calling UNLZH from a command line.  It will
  284. take the filename from command input, and do a full extract on the output
  285. path that was saved with the configuration.  (If the configuration has not
  286. been saved, files will be written to the default directory).  Full pathname
  287. inputs are allowed, and wildcards can be used for batch processing.  The
  288. 'Create Folders' and 'Overwrite Files' options have the same effects.  The
  289. program will exit after completion, or after any errors.
  290.  
  291. To bypass the main menu and other GEM prompts, enter an 'X ' in front of
  292. the input file.  (i.e. 'UNLZH X FILENAME' as in ARC.TTP).
  293.  
  294. In closing:
  295. -----------
  296.  
  297. You may make copies and distribute this program, as long as the program
  298. and documentation file remain unchanged, and are distributed together.
  299.  
  300. This program is shareware.  If you enjoy using it, please send $5 to me at
  301. the address below.  You may use the enclosed self-addressed envelope, by
  302. printing out the ENVELOPE.TXT file, and following its instructions.  Your
  303. printer should be set to start printing at the very top edge of the paper
  304. for best results.  Ideally, the bottom flap should be long enough to reach
  305. the middle fold line.  If it is too short, you may use a word processor to
  306. delete a few lines from the top of the document, and reprint it.
  307.  
  308. For those who send a contribution of $10, I will send back a desk accessory
  309. version of UNLZH.  If you have a GEnie account, I can also send updated
  310. versions of the program, before they are available for general download.
  311. All programs will be sent to you via Xmodem EMail.  For all others, I will
  312. send the desk accessory version by US mail.
  313.  
  314. $10 contributions may also be made using GEnie's Gift of Time feature.  To
  315. access it, type 'GIFTOFTIME' at any of the menu prompts.  It allows you to
  316. give a $10 GEnie credit, and gets added to your monthy billing.  GEnie does
  317. don't give On-Line confirmation of Gift of Time's, but sends a notice
  318. through the mail.  To guard against lost mail, and also to let me know
  319. what program you are registering, please send an EMail notice as well.
  320.  
  321. Please include the version number of the program, and GEnie account (if any)
  322. on any correspondence.  I hope you enjoy the program, and let me know of any
  323. comments.  PLEASE send suggestions for improvements and/or bug reports.
  324.  
  325. John Harris
  326. 45346 Graceway Dr.
  327. Ahwahnee, CA 93601
  328. (209) 683-3412
  329. GEnie: J.HARRIS32
  330.