home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / af0_32b.zip / Install.Txt < prev    next >
Text File  |  1996-10-18  |  12KB  |  277 lines
  1.                                     (1)
  2.  
  3. Archive Folder (AF) installation instructions:
  4. =========================================
  5.  
  6.  
  7.  
  8.  
  9.     Table of contents
  10.     =================
  11.  
  12.     Installation instructions...............................2
  13.  
  14.     Deinstallation instructions.............................3
  15.  
  16.     Archiver Registry - The Archiver program database.......4
  17.  
  18.     Format of ARCHIVER.BB2..................................5
  19.  
  20.     How archive listing works...............................6
  21.  
  22.     Notes on modifying/updating ARCHIVER.BB2................7
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                                     (2)
  30. Installation instructions
  31. =========================
  32.  
  33.  1. If you have version 0.20 installed or if you allready have AF installed
  34.     and want to install the new version in another directory you must first
  35.     delete the archive template folder in the installation directory.
  36.  
  37.  2. Extract the distribution archive AF0_XXB.ZIP to a temporary directory
  38.     OR to the directory where you want to keep the files
  39.  
  40.  3. Make the selected directory the current directory.
  41.  
  42.  4. Type INSTALL on the command line and press the ENTER or RETURN button.
  43.     You will be prompted for the language to use (currently danish or english)
  44.     and for the full path to the directory where you want to install AF.
  45.     If you want to keep AF in the current directory simply press ENTER when
  46.     prompted for installation directory.
  47.     Besides (optionally) copying the files, the installation script will
  48.     create the program object, templates, associations and filetypes used by AF.
  49.  
  50.  5. Optionally copy the ARCHIVER.BB2 file to a directory in the PATH or DPATH.
  51.     When Archive Folder and Archiver Registry looks for ARCHIVER.BB2 they first
  52.     look in the current directory then in the PATH and if not found in the DPATH.
  53.  
  54.  6. Optionally copy the AF.HLP file to a directory in the HELP path.
  55.  
  56.  7. Your archiver programs (ZIP.EXE, UNZIP.EXE, LH.EXE etc.) has to be in your
  57.     path else AF wont find them.
  58.  
  59.  
  60.  
  61.                                     (3)
  62. Archive Folder deinstallation:
  63. ==============================
  64.  
  65.  1. Make the installation directory the current directory.
  66.  
  67.  2. Type AFDEINST at the commandline and press the ENTER or RETURN button.
  68.     This will remove all program objects, templates, associations and
  69.     file types used by AF.
  70.  
  71.  
  72.                                     (4)
  73.  
  74. Archiver Registry - The Archiver program database
  75. =================================================
  76.  
  77. When you select "Edit Archivers" from the Options menu or doubble click on
  78. the "Archiver Registry" object the Archiver Registry will open.
  79.  
  80. Archiver Registry (AR) is an editor to the ARCHIVER.BB2 file which is a database
  81. with all the command lines etc. used by AF. ARCHIVER.BB2 is a simple text file
  82. and can be edited by hand but it is much more intuitive to use the Archiver
  83. Registry.
  84. The archivers is shown in a tree view to the left. When you click
  85. on the '+' sign next to an archiver name the tree expands and you can select
  86. the options for the archiver. When an option is selected the right window
  87. of AR changes. If it is a text entry there will be an entry box where you
  88. can fill in the needed information, if it is a value entry there will be
  89. a spinbutton which you can use to select the correct value.
  90.  
  91. When you right click on an archiver definition (The parent) you will have to
  92. menu option: "New archiver" which lets you create a new archiver definition,
  93. and "Delete" which deletes the selected archiver definition.
  94. When you right click on an archiver option (a child record) the menu option
  95. will be "New Archiver" and "Save entry". The latter saves the currently
  96. selected archiver option. This is the same as the "Save Entry" button to the
  97. right. This doesn't save the option to disk only to the internal structure of
  98. AR. When you want to save to disk you will have to select "Save all" from
  99. the "Archivers" menu.
  100.  
  101.  
  102.  
  103.                                     (5)
  104. Format of ARCHIVER.BB2
  105. ======================
  106.  
  107. I will shortly explain the format of the ARCHIVER.BB2. The explanition is a
  108. rewrite of an original text by Mark Kimes.
  109. The first line is a number which should always be 21. It shows the number of
  110. lines in each archiver definition and allows future modifications to the file
  111. format.
  112. The following 21 lines of each record contains the command lines and the
  113. format of the archiver output.
  114.  
  115. Format for this archiver.bb2 file (each entry has 21 lines):
  116.  
  117.  1st line:    ID of archiver (like ARC, LHARC, PKZIP, etc.; human consumption)
  118.         This line is edited from the "Name of archiver" entry in AR.
  119.  2nd line:    Normal extension for archives (like ZIP, ARC, LZH;
  120.         note no period)
  121.         This line is edited from the "Extension of archiver" entry.
  122.  3rd line:    Offset into file to signature.
  123.         This line is edited from the "Offset of signature" entry.
  124.  4th line:    List command. This command is used to make the archiver list
  125.         the files in the archive. You should usually use some kind
  126.         of verbose switch if the archiver supports it.
  127.         This line is edited from the "LIST command" entry.
  128.  5th line:    Extract command. Extract file(s) from archive junking any
  129.                 imbedded paths.
  130.         This line is edited from the "EXTRACT command" entry.
  131.  6th line:    Extract w/ directories command. Extract file(s) from archive
  132.         including imbedded paths.
  133.         This line is edited from the "EXTRACT w/dirs command" entry.
  134.  7th line:    Test archive command. Test archive integrity.
  135.         This line is edited from the "TEST command" entry.
  136.  8th line:    Add/create command. Add to, update or create archive.
  137.         This line is edited from the "ADD/CREATE command" entry.
  138.  9th line:    Add/create w/ paths command. Add to, update or create archive
  139.         including full paths to file.
  140.         This line is edited from the "CREATE w/dirs command" entry.
  141. 10th line:    Add/create & recurse command. Add to, update or create archive.
  142.         Recurse thru subdirectories.
  143.         This line is edited from the "CREATE recursively command" entry.
  144. 11th line:    Move command. Move into archive (delete original).
  145.         This line is edited from the "MOVE command" entry.
  146. 12th line:    Move w/ paths command. Move into archive (delete original).
  147.         Include full paths to files.
  148.         This line is edited from the "MOVE command" entry.
  149. 13th line:    Delete command. Delete file(s) from archive.
  150.         This line is edited from the "DELETE command" entry.
  151. 14th line:    Signature (case sensitive, leading spaces count!) See explanation
  152.         of the signature below.
  153.         This line is edited from the "Signature of archive type" entry.
  154.  
  155.                                     (6)
  156.  
  157. 15th line:    Startlist string. Start of the archive listing. See below for
  158.         details.
  159.         This line is edited from the "Start of list" entry.
  160. 16th line:    Endlist string. Start of the archive listing. See below for
  161.         details.
  162.         This line is edited from the "End of list" entry.
  163. 17th line:    Old size position  (all positions 0-based, -1 = not available)
  164.         This line is edited from the "Position of old size" spinbutton entry.
  165. 18th line:    New size position
  166.         This line is edited from the "Position of new size" spinbutton entry.
  167. 19th line:    File date position. Position of files date in archiver listing.
  168.         This line is edited from the "Position of file date" spinbutton entry.
  169. 20th line:    Number of positions in dates (for "03 June 92" would be 3).
  170.         This line is edited from the "Fields in date" spinbutton entry.
  171. 21st line:    File name position (absolutely required, of course; -1 = last pos)
  172.         This line is edited from the "Position of file name" spinbutton entry.
  173.  
  174. A semicolon demarks a comment.  they may appear at any point *except*
  175. within the 21 lines of an archiver entry.  comments are ignored by AF.
  176.  
  177. Note that all archiver strings should include the archiver's parameter to
  178. prevent it from stopping for input!  Also note that archive types are checked
  179. in order of their listing in this file.  finally, this file is set up for
  180. the archivers I had lying around; if yours are different versions, you may
  181. have to modify this file.
  182.  
  183. How archive listing works:
  184. ==========================
  185.  
  186. AF first tries to find a signature match. Failing that, the user is asked
  187. to select an archiver. AF then issues a LIST command with archive name as
  188. argument. 
  189. AF then parses the resultant output using the start and end list lines and
  190. offsets in file lines listed in this file for the given archiver.
  191.  
  192. If AF doesn't find one or both of the lines the archive is either of a
  193. wrong format or the archiver definition in archiver.bb2 is invalid.
  194.  
  195.                                     (7)
  196.  
  197. Notes on modifying/updating ARCHIVER.BB2:
  198. =========================================
  199.  
  200. You can add as many archivers as you like to this file.
  201. Here are some suggestions on how to go about it:
  202.  
  203. When you want to make a new archiver definition the easiest way is to redirect
  204. the output of the archiver to a file and the use the file to cut and paste
  205. the start and end of list lines to the appropriate entries in AR.
  206.  
  207. List an archive with the archiver, redirecting to a disk file
  208. (ex. "ARC l AFILE.ARC > TEMP.").  Load the resultant file into a text
  209. editor.  Clip out the startlist and endlist strings and paste directly
  210. into this file on the appropriate lines or into AR.
  211. Count the positions of filename, date, etc. and place on the appropriate line.
  212. Now run the archiver redirected to a file to get its help screen
  213. (ex. "ARC > TEMP." or "ZOO h > TEMP.").
  214. Look for the various command options (extract, list, etc.) and put them into
  215. the file on the appropriate lines -- remember to add the modifiers to prevent
  216. the archiver from stopping to ask questions!  You could be in deep doo-doo
  217. if it's a detached process.  While it may seem a pain in the arse to have to
  218. edit this file when an archiver changes its command structure or list format,
  219. at least it's something within your control, you don't have to wait for an
  220. update to AF.  That means if I die tomorrow you'll still be able to use AV
  221. for years to come.
  222.  
  223. Here's an example of an ARC listing (5.12mpl, command "ARC l"):
  224.  
  225. ----------------cut here----------------------
  226. Name          Length    Date
  227. ============  ========  =========    <--this line is start-of-list
  228. MAKEFILE           374  28 Nov 89
  229. QSORT.C          14279  29 Nov 89
  230. QSORT.EXE        24629  29 Nov 89
  231. STUFF.H            371  29 Nov 89
  232.         ====  ========               <--this line is end-of-list
  233. Total      4     39653
  234. ----------------cut here----------------------
  235.  
  236. Note the filename is in position 0, old length in position 1, and the
  237. date starts in position 2, with 3 parts, and there's no new length
  238. field (so it'd be -1).  Compare that to the archiver entry for
  239. ARC 5.12mpl above and you should get a feel for what all those fields
  240. mean.  Here's a diagram of how a file line breaks down:
  241.  
  242. STUFF.H            371  29 Nov 89
  243.   ^                 ^   ^
  244.   |                 |   |
  245.   |                 |   +--Date starts in field 2, 3 parts (29, Nov, and 89)
  246.   |                 |
  247.   |                 +--Old file length, field 1
  248.   |
  249.   +--Filename, field 0 (count from 0, not 1)
  250.  
  251.  
  252. If you're adding an entirely new archive format, note that you can
  253. use 'C'-style \x<hexnumber> on the signature line in this file.
  254. For example, the \x1a in ARC 5.12mpl's signature line means AF will
  255. look for an ASCII 26 (text EOF marker) in position 0 (first byte, as
  256. indicated by ARC's line 3, the offset into a file for the signature)
  257. of a file to determine if it's an archive.  If line 3's offset is
  258. negative, AF looks from the end of the file instead of the beginning.
  259. You can usually figure out what an archiver's signature is by looking
  260. at a few archives with a file viewing program like Vernon Buerg's 
  261. LIST.  By all means send me anything new you figure out for inclusion
  262. in future releases.
  263.  
  264. You can have several entries for one type of archive in this file.  AV
  265. tries entries sequentially to list the file until it finds one that works.
  266. It lets you create archives with more than one archiver that produces the
  267. same sort of archive (or with different switches, like one with LHArc
  268. producing -lh5- compression and one with it producing old, compatible
  269. -lh1- compression).
  270.  
  271. Note that when adding archivers you have to define at least the LIST command
  272. and it has to point to an executable file either in the current directory
  273. or in your PATH. If AR cannot find the executable the archiver definition will
  274. be ignored.
  275.  
  276. Always end file with blank line or comment
  277.