home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 10 / Fresh_Fish_10_2352.bin / new / util / arc / modpack / modpack.doc < prev    next >
Text File  |  1994-09-14  |  17KB  |  331 lines
  1.  
  2.                               ModPack V1.4b
  3.                             -----------------
  4.                              by  Mike Coenen
  5.  
  6.  
  7. INFO
  8.     This little assembler-program packs soudtracker-modules together with a
  9.     file containing additional information into an LHA-archive.
  10.     The program needs at least OS2.04, but it will run on every processor
  11.     of the 68000-family (that's not quite me, is it ?). In addition the
  12.     program 'LHA' is needed somwhere where you can reach it without having
  13.     to add a path (e.g. C:).
  14.     ModPack is ThinkWare. So if you use it frequently, you should think of
  15.     me...
  16.     A propos: I will NOT be held responsible for any damage or dataloss
  17.               caused in connection with ModPack!
  18.  
  19. SELECT FILES
  20.     As ModPack has to know which files to pack, you have to tell him somehow.
  21.     To do so, you have three choices.
  22.     You can call a file-requester by pressing the 'Add'-gadget and select the
  23.     desired modules (multiselect with SHIFT is allowed). You are also able
  24.     to drag icons directly into the ModPack window and drop them there (even
  25.     more than one, if you like). This would make more sense with large
  26.     numbers of modules, as you can show files without icons on the Workbench
  27.     as well. Third, you can do an ExtendedSelect. That means you click once
  28.     on the ModPack-icon, and then with the SHIFT-key held down click on all
  29.     files you want to be loaded. Do a double-click on the last icon (SHIFT
  30.     still pressed) so that ModPack is started and the files will be read.
  31.     If you want to select an entire directory, but it is unreachable from
  32.     Workbench because it lies in a fifth-level-subdirectory without any
  33.     icons or whatever, you don't have to 'Window/Show/All Files' all
  34.     directories. Just click 'Add', select the desired directory and press
  35.     'Add' in the file requester without selecting ANY file. Then the entire
  36.     directory will be analyzed. Note that by selecting entire directories
  37.     the pattern defined in the ToolTypes (or the default one) will be used
  38.     and NOT the one in the file requester. That's because I don't know how
  39.     to access it.
  40.  
  41.     The selected files are then examined and, together with their size,
  42.     displayed in the ListViewGadget. If you want to add some modules to the
  43.     List later on, just repeat the procedure and the new files will be
  44.     attached at the end of the list. Don't care about the path - it doesn't
  45.     matter. In fact every file could be in an other directory, ModPack
  46.     handles it automatically.
  47.     The number of selected files can be seen in the bottom left hand corner
  48.     in the 'Cnt:'-TextGadget.
  49.     ModPack recognizes files crunched with the PowerPacker or the Imploder.
  50.     Such files will be marked in the ListViewGadet with a "P" for "Power-
  51.     Packer" or an "I" for "Imploder". The RealName will in such cases only
  52.     be "PP_x" or "IMP_x", where x is a number.
  53.  
  54. EDIT FILES
  55.     When you select an item from the ListViewGadget, some information will
  56.     become visible on the left side, as there are:
  57.     'RealName': This TextGadget displays the module's name. This is not the
  58.                 filename but the 'real one' which is read from the file.
  59.     'Filename': Here, the filename of the arcive will be displayed. It will
  60.                 be assembled from the RealName and the suffix '.lha'.
  61.                 All spaces, colons, slashes, full stops, commas, and "_"s
  62.                 (I dont't know what a '_' is called in english...) will be
  63.                 thrown out, and the following character will be capitalized
  64.                 (Ä, Ü, ö etc. treated correctly). 'live long,and_Prosper'
  65.                 would therefore be converted into 'LiveLongAndProsper'.
  66.     'Composer': The Composer... The name will be extracted from the file's
  67.                 comment which must have the following format:
  68.                 COMPOSER^FROM^INFO
  69.                 The character '^' operates as separator, where it is not
  70.                 necessary for all three fields to be existent. Valid is for
  71.                 example '^^Metal', what leads to an empty Composer- and
  72.                 From-String, and to an Info-String containing 'Metal'. You
  73.                 can enter 'Mike Coenen' as well, so that the Composer will be
  74.                 'Mike Coenen' and the rest will be empty ('Mike Coenen^^'
  75.                 will, of course, work too).
  76.     'From'    : The source of the module (e.g. Demo xyz). This will be
  77.                 extracted from the file's comment which must have the
  78.                 following format: COMPOSER^FROM^INFO
  79.     'Info'    : This field can contain many things, for example the kind of
  80.                 music... The Info-string will be extracted from the file's
  81.                 comment which must have the following format:
  82.                 CMOPOSER^FROM^INFO
  83.     Except for the RealName you can edit everything, even the name of the
  84.     archive, which, in many cases, might be not quite like you want it.
  85.     But Attention! ALL INPUTS WILL ONLY BE ACCEPTED AFTER PRESSING RETURN,
  86.     TAB OR SHIFT-TAB! IF A STRINGGADGET IS INACTIVATED BY A MOUSECLICK, THE
  87.     CHANGE WILL NOT BE CARRIED OUT !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  88.     ALL STRINGGADGETS IN THIS PROGRAM WILL HANDLE IT THIS WAY !!!!!!!!!!!!!
  89.  
  90. DELETE FILES
  91.     If you want to delete a file from the list, just select it, and click on
  92.     'Del'.
  93.     By clicking on 'ClrAll' you can delete all entries in the ListViewGadget.
  94.     There won't be any changes on disk when you delete an entry. Only the
  95.     items in the list will be affected.
  96.  
  97. SAVE INFO
  98.     ModPack offers you the possibility to save the info displayed on the
  99.     left as an ASCII-file. Click on 'Save' and a file requester will open.
  100.     Select or enter the filename and confirm it. Should the file already
  101.     exist, you can either overwrite it or append the new information. As a
  102.     third option you can cancel and not do anything.
  103.  
  104. (DONT'T) PAY ATTENTION TO COMMENT
  105.     With the CheckboxGadget you can define whether ModPack shall examine
  106.     the module's file comment or not. If the comment is not in the format
  107.     'COMPOSER^FROM^INFO' there might be some unwanted results which have
  108.     to be corrected manually. So you can switch this function off to ignore
  109.     the comment. Note that ignoring the comment can only be done while
  110.     selecting files. Once a file is in the list, switching on or off will
  111.     have no effect.
  112.     The default is 'COMMENT=TRUE' that makes the comment to be examined.
  113.     If you want to have it the other way round just from the start, set
  114.     'COMMENT=FALSE' in the ToolTypes. This would then be the predefined
  115.     setting when launched from the Workbench.
  116.  
  117. 8 CHARACTER LIMIT
  118.     This has been implemented in order to save MS-DOS users from total
  119.     despair. I did see more than one BBS crashing because of too long file-
  120.     names. If activated the filenames of all Modules in the ListView will
  121.     be truncated to eight characters plus '.lha'. Making the option inactive
  122.     causes all filenames to be normal again :-)
  123.     This can also be controlled by the ToolTypes. Add 'CHARLIMIT=TRUE' to
  124.     activate it right from the start.
  125.  
  126. EXTERNAL ID
  127.     As the default file_id.diz-layout might surely not please everyone, I
  128.     added the possibility to use you own IDs. You have to set up two ASCII-
  129.     files, one for the 'full' ID and one for the 'empty' one. Add the Tool-
  130.     Types 'FILEIDFULL=File' (where 'File', of course, can be any valid path
  131.     to a file) and 'FILEIDEMPTY=File'. Only if those two entries are valid,
  132.     the CheckboxGadget will be enabled.
  133.     The File can be as long as you want it to be. To insert the RealName
  134.     you have to type '^R_$(xx)' where xx is a number indicating the length
  135.     of the string (shorter ones will be padded with SPACEs). The keyword
  136.     for the composer is '^C_$(xx)', for the From-entry '^F_$(xx)' and for
  137.     the Info-entry '^I(xx)'. so it could look like:
  138.  
  139.     A MODULE...
  140.     ======================================
  141.     RealName    : ^R_$(20)
  142.     --------------------------------------
  143.     Author      : ^C_$(30)
  144.     --------------------------------------
  145.     From        : ^F_$(7)
  146.     -----