home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / packer / sit / unstuff.doc < prev    next >
Text File  |  1992-11-22  |  19KB  |  439 lines
  1. UNSTUFF (tm) version 1.0 for DOS compatible computers.
  2.  
  3. Freeware StuffIt decompression utility written by Jody P. Nickel
  4. Documentation written by Marco A. Gonzalez
  5. Copyright (c) 1992 Aladdin Systems, Inc. and Raymond Lau. All Rights Reserved.
  6.  
  7. -----------------------------------------------------------------------------
  8. INTRODUCTION
  9. -----------------------------------------------------------------------------
  10. UNSTUFF is a program that can decompress the contents of StuffIt archives
  11. including archives created with StuffIt 1.5.1 through StuffIt Deluxe 3.0.3.
  12. Items which have been encrypted or optimized (with a StuffIt compression
  13. optimizer) cannot be unstuffed by this version of UNSTUFF.
  14.  
  15. You may freely distribute this package to anyone who needs access to StuffIt
  16. archives provided that UNSITINS.EXE (the installer that includes UNSTUFF.EXE
  17. and this file, UNSTUFF.DOC) is distributed in whole. Although you can
  18. distribute this product to your friends for free, it cannot be redistributed
  19. as part of a commercial product without a license from Aladdin Systems, Inc.
  20. Aladdin Systems allows free distribution of the UNSTUFF package on all major
  21. online services, bulletin boards, and user group disks.
  22.  
  23. What is StuffIt?
  24. StuffIt is the Macintosh industry standard compression and archiving
  25. application. Most Macintosh telecommunication users and users who wanted to
  26. save disk space were never caught without their most recent version of
  27. StuffIt. Aladdin Systems provides the StuffIt program in shareware (StuffIt
  28. Lite) and commercial versions(StuffIt Deluxe). Each has its benefits.
  29.  
  30. For years, StuffIt Deluxe has been able to access PC compressed archives, but
  31. PC users were not able to access StuffIt archives. Now with this UNSTUFF
  32. program, PC users also can UnStuff files from StuffIt archives. As a PC
  33. user, you'll see thousands of StuffIt archives in the Macintosh (and some
  34. other) forums on online services and BBSs. With UNSTUFF, you'll have access
  35. to these files! As a matter of fact, online services such as CompuServe and
  36. America Online have made StuffIt archives their recommended standard method
  37. of posting Macintosh files.
  38.  
  39. What is a StuffIt archive?
  40. A StuffIt archive is a file that contains one or more compressed files and
  41. directories. Most StuffIt archives have the ".sit" extension in their
  42. filename so they are easy to recognize.
  43.  
  44. There are three advantages to storing documents in an archive: (1) archives
  45. usually contain compressed files, and thereby save space on disk and reduce
  46. the time it takes to transmit them over phone lines or networks; (2) files
  47. stored in an archive can be sent over networks and telecommunication lines
  48. as a single file making it easier for other people to retrieve all related
  49. material; (3) associated files can be kept in one archive for easy retrieval
  50. and backup.
  51.  
  52. Terms and Conventions
  53. An "archive item" is any file or directory located in a StuffIt archive.
  54.  
  55. "Archive.sit" is used to indicate any StuffIt archive. You should type the
  56. name of the archive that you wish to indicate whenever you see "archive.sit"
  57. used in this documentation.
  58.  
  59.  
  60. -----------------------------------------------------------------------------
  61. COMMAND LINE OPTIONS
  62. -----------------------------------------------------------------------------
  63.  
  64. UnStuff Archive Contents
  65. ------------------------
  66. YOU TYPE: unstuff archive
  67. OR
  68. YOU TYPE: unstuff archive.sit
  69.  
  70. EXPLANATION
  71. This command extracts every item from the archive indicated into the current
  72. directory. The above example indicates an archive named "archive.sit". It is
  73. not necessary to type the ".sit" extension. You may include optional
  74. parameters in the command line either before or after the archive name to
  75. modify how the unstuffing process will work. For example, to have UNSTUFF
  76. walk you through an unstuffing process, you can type the following line:
  77.   unstuff -i archive
  78. where "archive" is the actual archive name.
  79. See "Interactive Mode" below for detailed explanation of the "-i" option.
  80.  
  81.  
  82. Display Help
  83. ------------
  84. {none}   = display help
  85. -h OR -? = display help
  86.  
  87. YOU TYPE: unstuff
  88. OR
  89. YOU TYPE: unstuff -?
  90. OR
  91. YOU TYPE: unstuff -h
  92.  
  93. YOUR COMPUTER DISPLAYS:
  94. UNSTUFF (tm) version 1.0, Freeware decompression utility by Jody P. Nickel
  95. Copyright (c) 1992 Aladdin Systems, Inc. and Raymond Lau. All Rights Reserved.
  96. Extract files from StuffIt (tm) 1.5.1, and StuffIt Deluxe (tm) 1.0-3.0 archives
  97.  
  98. Usage: UNSTUFF [options] [archivename[.sit]]
  99. Options:
  100. {none}   = display help
  101. -c[rlf]  = do CR -> CR LF translation on Mac text files
  102. -d       = don't create directories
  103. -h OR -? = display help
  104. -i       = interactive. Prompt to UnStuff each archived item
  105. -l       = list archive contents
  106. -lv      = verbose (more detailed) listing
  107. -mb      = UnStuff each file into MacBinary format
  108. -n       = UnStuff files from archive that are newer than existing files
  109.            Any files in the archive that are not on disk will also be
  110. UnStuffed
  111. -o<dir>  = output, UnStuff to this directory
  112. -r       = replace existing files/directories without asking
  113. -t       = test the integrity of the archive
  114.  
  115. Commercial distribution restricted. For information, contact Aladdin
  116. Systems,
  117. 165 Westridge Drive, Watsonville, CA 95076. (408) 761-6200. fax:(408)
  118. 761-6206
  119. CIS:75300,1666  GEnie:ALADDINSYS  internet:aladdin@well.sf.ca.us 
  120. AOL:ALADDIN
  121.  
  122.  
  123.  
  124. Convert Text File Line Endings from Macintosh to DOS
  125. ----------------------------------------------------
  126. -c[rlf]  = do CR -> CR LF translation on Mac text files
  127.  
  128. YOU TYPE: unstuff -c archive.sit
  129. OR
  130. YOU TYPE: unstuff -crlf archive.sit
  131.  
  132. EXPLANATION
  133. In a Macintosh text file, each line or paragraph ends with a carriage return
  134. ("CR") character. On a DOS compatible machine, text files typically have
  135. each line or paragraph terminated by a carriage return together with a line
  136. feed character ("CR LF"). If you use this option, UNSTUFF will automatically
  137. convert all carriage returns to carriage returns/line feeds ONLY when
  138. unstuffing text files from an archive.
  139.  
  140.  
  141. Don't Create Directories
  142. ------------------------
  143. -d       = don't create directories
  144.  
  145. YOU TYPE: unstuff -d archive.sit
  146.  
  147. EXPLANATION
  148. StuffIt archives may contain directories. If you don't want subdirectories
  149. created, and you want all the files in the archive to be unstuffed into a
  150. single directory, use the -d option.
  151.  
  152.  
  153. Interactive Mode
  154. ----------------
  155. -i       = interactive. Prompt to UnStuff each archived item
  156.  
  157. YOU TYPE: unstuff -i archive.sit
  158.  
  159. YOUR COMPUTER DISPLAYS: (example)
  160. UnStuff "filename" to C:\DOCS\filename ?
  161. (Yes/No/Rename/Cancel)
  162.  
  163. EXPLANATION
  164. Interactive mode leads you through the unstuffing procedure by asking if you
  165. want to unstuff each file. UNSTUFF will accept your first keypress as the
  166. answer to the question. Press "Y" to unstuff the file keeping the same name
  167. as in the archive. Press "N" to skip this file and go on to the next file in
  168. the archive. Press "R" if you want to unstuff the file, but want to give it
  169. a different name. Press "C" to cancel the whole interactive unstuff process,
  170. and get back to the DOS prompt. Interactive mode is useful for unstuffing an
  171. individual file without having to unstuff the whole archive.
  172.  
  173.  
  174. List Archive Contents
  175. ---------------------
  176. -l       = list archive contents
  177.  
  178. YOU TYPE: unstuff -l archive.sit
  179.  
  180. YOUR COMPUTER DISPLAYS: (example)
  181. Name                                          Saved
  182. --------------------------------------------- -----
  183. ReadMe.txt                                      82%
  184. Docs.txt                                        78%
  185. File3                                           82%
  186. MyDir                                           59%
  187.  test1                                          55%
  188.  test2                                          60%
  189. ---------------------------------------------------
  190.   6 Items                                       73%        
  191.  
  192. EXPLANATION
  193. The -l option is used to display the names of the files and directories that
  194. are stored in the archive file. The first column displays the name of the
  195. file or directory ("item"). Items that are found within a directory are also
  196. listed but they are indented after the directory name. The second column
  197. shows how much space was saved due to compression. The space savings are
  198. indicated by a percentage. For example, if the percentage shown is 73%, it
  199. means that the file was compressed down to 27% of its original size. The
  200. larger the percentage the more the file was compressed.
  201.  
  202.  
  203. Verbose Listing
  204. ---------------
  205. -lv      = verbose (more detailed) listing
  206.  
  207. YOU TYPE: unstuff -lv archive.sit
  208.  
  209. YOUR COMPUTER DISPLAYS:
  210. Name                    Type Crea Label       Date  Expanded  Stuffed Saved
  211. ----------------------- ---- ---- -----   --------  --------  ------- -----
  212. ReadMe.txt              TEXT MSWD -        1/28/92     53275    9325    82%
  213. Docs.txt                TEXT MSWD -       10/ 9/91     17050    3601    78% 
  214. File3                   TEXT MSWD -        9/20/91     10031    1737    82%
  215. MyDirectory             2 Items           11/22/92     45792   18362    59%
  216.  test1                  TEXT MSWD -        5/19/92      6144    2729    55%
  217.  test2                  TEXT MSWD -       11/11/92     39424   15633    60%
  218.                         ---------------------------------------------------
  219.                         6 Items                       126372   33025    73% 
  220.      
  221.  
  222. EXPLANATION
  223. The verbose or detailed archive listing shows more specifics than the simple
  224. listing accessed with the -l option.
  225. The Type column shows the "type" attribute that the Macintosh assigns to
  226. this type of file. A typical type is "TEXT".
  227. The Crea column stands for "Creator" which is the attribute that indicates
  228. which application created the file. A typical creator is "MSWD", which
  229. indicates that  Microsoft Word created the file.
  230. The Label column displays the Label assigned to the file by the Macintosh
  231. Finder. UNSTUFF will display the default labels, and not labels customized
  232. by users.
  233. The Date column displays the date the archived item was modified.
  234. The Expanded column shows the original size of the item in bytes.
  235. The Stuffed column indicates the size that the item occupies in the archive,
  236. that is, compressed size.
  237. The Saved column displays how much space was saved due to compression. This
  238. is the same column that is displayed in the simple listing ("-l").
  239.  
  240.  
  241. UnStuff into MacBinary format
  242. -----------------------------
  243. -mb      = UnStuff each file into MacBinary format
  244.  
  245. YOU TYPE: unstuff -mb archive.sit
  246.  
  247. EXPLANATION
  248. Each file will be unstuffed and placed into a MacBinary format. Since a
  249. Macintosh file is composed of two pieces (a data fork and a resource fork)
  250. and a DOS machine only recognizes one piece (the data fork), a Macintosh
  251. file cannot reside on a DOS machine and keep its resource fork unless its
  252. stored in MacBinary format. Most telecommunication programs can un-MacBinary
  253. a file and there are also shareware programs that can un-MacBinary a file.
  254.  
  255.  
  256. UnStuff Newer Files
  257. -------------------
  258. -n       = UnStuff files from archive that are newer than existing files
  259.            Any files in the archive that are not on disk will also be
  260. UnStuffed
  261.  
  262. YOU TYPE: unstuff -n archive.sit
  263.  
  264. EXPLANATION
  265. Before UnStuffing, each file in the archive is compared to the same-named
  266. file on disk. If a corresponding file is not found on disk, the file will be
  267. unstuffed from the archive. If a corresponding filename is found on disk AND
  268. the file to be unstuffed has been modified more recently than the file on
  269. disk, the file in the archive will be unstuffed.
  270.  
  271.  
  272. Output to Specified Directory
  273. -----------------------------
  274. -o<dir>  = output, UnStuff to this directory
  275.  
  276. YOU TYPE: unstuff -o B: archive.sit
  277. OR
  278. YOU TYPE: unstuff archive.sit -o B:
  279.  
  280. EXPLANATION
  281. This option will unstuff files to the specified directory. Notice that
  282. UNSTUFF will accept command line options before or after the archive name.
  283. The most common place to use the -o option is after the archive name.
  284.  
  285.  
  286. Replace Existing Items without Asking
  287. -------------------------------------
  288. -r       = replace existing files/directories without asking
  289.  
  290. YOU TYPE: unstuff -r archive.sit
  291.  
  292. EXPLANATION
  293. If UNSTUFF encounters an item with the same name in the destination
  294. directory as in the archive, it will not unstuff the archived item. To make
  295. UNSTUFF automatically overwrite items with the same name, include the -r
  296. option in the command line.
  297.  
  298.  
  299. Test Archive Integrity
  300. ----------------------
  301. -t       = test the integrity of the archive
  302.  
  303. YOU TYPE: unstuff -t archive.sit
  304.  
  305. EXPLANATION
  306. UNSTUFF will check the integrity of the archive by verifying that the files
  307. in an archive are stored correctly and will be unstuffed flawlessly.
  308.  
  309.  
  310. -----------------------------------------------------------------------------
  311. LEGAL
  312. -----------------------------------------------------------------------------
  313. Although the UnStuff(tm) software is copyrighted, it is being licensed to
  314. you for your use free of charge. However, ownership of and interest in this
  315. package shall remain with Aladdin Systems, Inc. Use and distribution is
  316. governed by the following terms in an effort to reasonably ensure that no
  317. one other than Aladdin Systems will derive a commercial benefit from
  318. distributing this package.
  319.  
  320. LICENSE AGREEMENT
  321. "You", "your", and the "user" refers to any person or entity which obtains
  322. or uses this software.
  323.  
  324. "Software" refers to any computer programs identified at the start of this
  325. documentation file, together with all codes, techniques, software tools,
  326. formats, designs, concepts, methods, ideas, and documentation associated
  327. with the computer program(s). The term also includes all copies of any part
  328. of the software and documentation.
  329.  
  330. "Aladdin" refers to Aladdin Systems, Inc.
  331.  
  332. This software is owned by Aladdin and contains valuable and proprietary
  333. information of Aladdin. If you violate any part of this agreement, your
  334. right to use this software terminates automatically. In the event of
  335. termination of this agreement, you must destroy all copies of this software
  336. and derivatives in your possession and cease distributing the same.
  337.  
  338. This software is being licensed to you as provided by the terms of this
  339. agreement.
  340.  
  341. You may:
  342. 1. Use this software on as many computers as you want at any given time.
  343. 2. Make as many backup copies of this software as you like.
  344. 3. Alter the software in any manner as you see fit FOR YOUR OWN PERSONAL
  345. USE. Such altered version should not be distributed. The creation of such
  346. derivatives shall not diminish Aladdin's title to this software.
  347. 4. Terminate this agreement at any time by destroying all copies of this
  348. software and derivatives of this software and cease distributing the same.
  349.  
  350. You may not:
  351. 1. Create any derivatives works from this software for distribution.
  352. 2. Reverse engineer, disassemble, decompile, or otherwise attempt to
  353. discover the logic or source code to this software.
  354.  
  355. UnStuff may be distributed for non-commercial purposes.
  356.  
  357. UnStuff may also be freely distributed via wire or electronic communications
  358. (bulletin boards [BBS's] and online information systems) for the sole
  359. purpose of use by their customers.
  360.  
  361. Contact Aladdin Systems at the address within this document if you wish to
  362. distribute this software in a compilation or commercial usage, or if you
  363. have any questions about re-distribution.
  364.  
  365. DISCLAIMER OF WARRANTY
  366. In using this software, you understand and agree that this software is
  367. provided "as is" without warranty of any kind. The entire risk as to the
  368. results and performance of using this software lies entirely with you, the
  369. user. Aladdin does not make any warranties, either expressed or implied,
  370. including but not limited to implied warranties of merchantability and
  371. fitness for a particular purpose, with respect to this software.
  372.  
  373. In no event shall Aladdin be liable for any consequential, incidental, or
  374. special damages whatsoever (including without limitation damages for loss of
  375. critical data, loss of profits, interruption of business, and the like)
  376. arising out of the use or inability to use this software. Because some
  377. states do not allow the exclusion or limitation of liability for
  378. consequential or incidental damages, the above limitations may not apply to
  379. you.
  380.  
  381. Although Aladdin would appreciate any feedback and bug reports, Aladdin will
  382. not be responsible for correcting any problems which you discover or
  383. otherwise help you maintain and use this software. Furthermore, Aladdin may
  384. at any time replace, modify, alter, improve, enhance, or change this
  385. software.
  386.  
  387. COMPLETE AGREEMENT
  388. This agreement constitutes the entire agreement and supercedes any prior
  389. agreements between you and Aladdin concerning this software. This agreement
  390. cannot be amended, modified, or waived excepting in writing.
  391.  
  392. GENERAL
  393. If any provision of this agreement shall be found to be unenforceable, it
  394. shall be deemed severed from the remainder of this agreement.
  395.  
  396. This agreement shall be construed in accordance with the laws of the State
  397. of California. Any arbitration or litigation relating to this agreement
  398. shall take place in the State of California. The parties further submit to
  399. waive any objections to personal jurisdiction of and venue in any of the
  400. following forums: U.S. District Court for the Northern District of
  401. California, California Superior Court for Santa Cruz County, Santa Cruz
  402. County Municipal Court or any other forum in Santa Cruz County, for any
  403. litigation arising out of this agreement.
  404.  
  405. U.S. GOVERNMENT RESTRICTED RIGHTS
  406. This software is provided with RESTRICTED RIGHTS. Use, duplication, or
  407. disclosure by the government is subject to restrictions set forth in
  408. subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer
  409. Software clause at 48 CFR 252.227-7013, or in subparagraphs (a) through (d)
  410. of the Commercial Computer Software Restricted Rights clause at 48 CFR
  411. 52.227-19, as applicable. The contractor/manufacturer is Aladdin Systems,
  412. Inc; 165 Westridge Drive; Watsonville, CA 95076.
  413.  
  414. All trademarks are held by their respective owners.
  415.  
  416.  
  417. -----------------------------------------------------------------------------
  418. ABOUT ALADDIN SYSTEMS
  419. -----------------------------------------------------------------------------
  420. mailing address: Aladdin Systems, Inc                     phone:408-761-6200
  421.                  165 Westridge Drive                        fax:408-761-6206
  422.                  Watsonville, CA 95076
  423.  
  424. online services: AppleLink:      ALADDIN
  425.                  America Online: ALADDIN
  426.                  CompuServe:     75300,1666
  427.                  GEnie:          ALADDINSYS
  428.                  internet:       aladdin@well.sf.ca.us
  429.  
  430. Aladdin Systems provides technical support over the phone, fax, and through
  431. the online services listed above. Please visit our forums on America Online,
  432. AppleLink, and CompuServe.
  433.  
  434. Aladdin Systems, Inc. develops and markets industry standard compression and
  435. utility products for the Macintosh and IBM PC (and compatible) computers.
  436.  
  437. Contact us for free product information.
  438.  
  439.