home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Cruncher / xpk-Knight_105.lha / XPK-KNIGHT / xpk-knight.doc < prev    next >
Encoding:
Text File  |  1994-12-08  |  17.2 KB  |  560 lines
  1.  
  2.                         X P K - K N I G H T
  3.                         -------------------
  4.  
  5.                    The GUI for the xpkmaster.library
  6.  
  7.               $VER: XPK_Knight.doc V1.05 -  08.12.1994
  8.  
  9.  
  10.                       © 1994 by A.Grossberger
  11.                          All rights reserved
  12.  
  13.  
  14.  
  15.  
  16. What is XPK-KNIGHT ?
  17. -----------------------
  18.  
  19. XPK-KNIGHT is a free configurable, easy Graphic-Userinterface for
  20. comfortable usage of most of the important functions whithin the
  21. XPKMASTER.library and its correspondending XPK-packers.
  22.  
  23.  
  24.  
  25.  
  26. Functions-Overview
  27. -----------------
  28.  
  29.  - easy todo intuition-steering by mouse with additional shortcuts
  30.  
  31.  - usefull as single (de)packer as well as for automatic operations
  32.    on large amount of data or even simply as a .xpk-files-tester
  33.  
  34.  - an internal script allows independent packing of data-files also
  35.    on different devices. This process can very simply be programmed
  36.    by the user via filerequester and few mouse-clicks.
  37.  
  38.  - subsequent inserting or deletion of script-entries is possible
  39.  
  40.  - the number of entries is limited only by your available RAM
  41.  
  42.  - build-in safety against loss of data during file-saving
  43.  
  44.  - the options of xpk-packers(chunksize, packmode, password) can be
  45.    chosen as easily by mousebutton as the program-process or -priority
  46.  
  47.  - any failures are caught in a safe way without terminating the
  48.    program and will then be marked for later control
  49.  
  50.  - free choice of best suitable packers or even automatic searching
  51.    for the best packratio with the so called "Try-Mode"
  52.  
  53.  - automatic information about the kind of files there is worked on
  54.  
  55.  - shows all possible features of the available xpk-packers
  56.  
  57.  - open concept for adding each future xpk-crunchers
  58.  
  59.  - suffixes, icons and filecomments can be handled separately
  60.  
  61.  
  62.  
  63. Distribution
  64. ------------
  65.  
  66. XPK-KNIGHT is (c) copyrighted 1994 by A. Grossberger.
  67.  
  68. XPK-KNIGHT is shareware and may be freely distributed (but NOT
  69. for any commercial use!) as long as the entire archive is not
  70. changed in any way and contains the following files:
  71.  
  72.         - XPK-KNIGHT_00         46264 bytes
  73.         - XPK-KNIGHT_00.info      762 bytes
  74.         - XPK-KNIGHT_30         45336 bytes
  75.         - XPK-KNIGHT_30.info     1522 bytes
  76.         - XPK-KNIGHT.dok        19439 bytes
  77.         - XPK-KNIGHT.doc        17660 bytes
  78.         - XPK-KNIGHT-History     1235 bytes
  79.         - XPK-KNIGHT-History-eng 1133 bytes
  80.  
  81.  
  82. (The icons are compatible to all Processor (68000/68030) Versions of course:-) )
  83.  
  84. This software is provided "as is". No warranties are made to its
  85. accuracy, reliability, performance or currentness of operation in
  86. any way. You do use it at your own risk!
  87. This software has been tested carefully on different Amiga-computers.
  88. But for the security of your data: Please do read this document !
  89.  
  90. XPK-KNIGHT may be included in public-domain-packages as long as a
  91. single disk it is on doesn't cost more than US$ 5 or DM 8.-.
  92.  
  93. If you like this program and keep using it, than register please.
  94. You are free to decide what it individually is worth for you and
  95. send that cash or as Euro-Cheque.
  96.  
  97. Should this be much less than US$ or DM 10.- better give it as a gift
  98. to UIISP  (Union of innocent impoverished shareware-programmers). ;-)
  99.  
  100. My address for registration is located at the end of this doc.
  101.  
  102. And once more: The program-author gives no warranty of any  kind.
  103.  
  104. But don't worry, be happy.;-) XPK-KNIGHT was developed very sorroughly
  105. and tested hard by some amiga-users. It worked many night-hours alone
  106. and un-watched together with my BBS-program on many thousands of my
  107. precious mod-files. And so did some of friends of mine. Not a single bit
  108. was lost. ;-) This program works fine in Amiga's multitasking-environment.
  109.  
  110.  
  111.  
  112. The idea behind
  113. ---------------
  114.  
  115. As sysop of the Musikbox-BBS I get lots of differently packed files
  116. uploaded. For unique managing and best pack-ratios there is only one
  117. solution: the open xpk-concept with its many packers. And for using
  118. them as easily as possible I wrote XPK-KNIGHT.
  119.  
  120.  
  121.  
  122.  
  123.                           Sytem-Requirements
  124.                           ------------------
  125.  
  126.             - Kick 2.04 (V37), better higher
  127.             - xpkmaster.library V2,  better higher
  128.  
  129.  
  130.               if possible:
  131.  
  132.             - many good xpk____.libraries
  133.             - fileID.library V2 or  higher
  134.             - powerpacker.library
  135.             - harddisk (or with disks MUCH patience ;-) )
  136.  
  137.  
  138.  
  139.  
  140.                               Operation
  141.                               ---------
  142.  
  143.  
  144.                 Gadgets
  145.                 -------
  146.  
  147.  
  148. Load        - in Direct mode: load and work on ONE FILE
  149.             - in Script mode: chose SEVERAL FILES and insert them at
  150.                               list-windows actual position or get
  151.                               whole directories (also recursive)
  152.  
  153.             - Shortcut "L"
  154.  
  155. DestDir     - chose destination-directory for script via requester.
  156.               If the pathname is deleted XPK-KNIGHT automatically sets
  157.               source-dir as target (default)
  158.  
  159.             - Shortcut "D"
  160.  
  161. Save        - in different ways as chosen with prefs (icons, suffix,
  162.               comments and deleting of the original (delsource))
  163.               in script-mode saving is done automaticly
  164.  
  165.             - Shortcut "S"
  166.  
  167. Save As     - like save with any filename
  168.             - requester, if any file with same name already exists
  169.  
  170.             - Shortcut "A"
  171.  
  172. Del Source  - Originalfile will be deleted after the new file has been
  173.               saved successfully
  174.             - there appears  no security-requester when the packed file
  175.               gets the same name as the original
  176.  
  177. Copy Icon   - ....hmm, difficult ;-)
  178.  
  179. Add.xpk     - ADD  xpk.suffix after packing - ".pp" suffix will be replaced
  180.             - REMOVE suffix when depacking
  181.  
  182. Passwort    - ON/OFF-switch so the passwort can be de-/activated whithout
  183.               need to write or delete the password-string each time
  184.  
  185.             - on the right side of that switch there is the string-gadget
  186.               for the passwort the file is de-/crypted with (if the chosen
  187.               packer can do that, of course)
  188.  
  189.  
  190. Cyclegadget for choice of packers (right of "Del Source")
  191.  
  192.             - chose your wished packer or TRY-Mode
  193.               (but this works faster with menu)
  194.  
  195. Info-Gadget - open the infowindow (infos about packer and packmodes)
  196.             - see also "Infowindow"
  197.  
  198. Chunksize   - 0 selects the DEFAULT-value of the packer (Chunksize in KB)
  199.               ATTENTION!: Leave this value on 0 (default), otherwise you
  200.               risc that your files can NOT be unpacked on other machines!
  201.               Specialists who know what they do wouldn't need no advice
  202.               on this feature at all.
  203.               Some sublibraries have problems with other values than
  204.               default! This is NOT a bug in XPK_KNIGHT.
  205.  
  206.             - will with each chosen file be shortended to possible maximum
  207.               of the actual packer or to filesize. In next step the entry-
  208.               value will be used again.
  209.  
  210.  
  211.               Please do keep in mind:
  212.  
  213.               the BIGGER the chunksize is
  214.  
  215.               - the better gets the compression
  216.               - the longer pack-process can last
  217.               - the longer you have to wait for aborting
  218.               - ATTENTION: the bigger gets DANGER that packed files
  219.                 can NOT be unpacked on other machines!
  220.                 I repeat: Do leave chunksize on 0 = default
  221.  
  222.               - menue-item "Default" sets chunksize to 0 kB
  223.  
  224. Cycle-Gadget for packmode
  225.  
  226.             - Pack  : file(s) PACK ONLY  and ignore already packed
  227.             - Repack: DEPACK and PACK AGAIN with chosen packer
  228.             - Unpack: DEPACK and ignore non-packed
  229.             - Test  : test file(s): are they ok and can be unpacked?
  230.                       plus informations about this file
  231.  
  232. Cycle-Gadget for Scriptmode
  233.  
  234.             - toggle between DIREKTMODE and SKRIPTMODE
  235.  
  236. Execute     - do the script (if no other choices are made by the user,
  237.               each source-dir also is destination-dir)
  238.  
  239. Del Step    - delete actual (clicked-on) entry out of script
  240.  
  241. Clr Prg     - delete all (complete) or the already finished program-steps
  242.               (Ready steps only)
  243.  
  244. Why Fail    - shows failures that appeared at actaul entry
  245.             - Shortcut "F"
  246.  
  247. Log File    - for future use only... ;-)
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.                 Displays
  255.                 --------
  256.  
  257.  
  258.  
  259. File :        filename
  260.  
  261. Type :        type of files (only when fileID.library is in system)
  262.               output updated even on just temporarely depacked files
  263.  
  264. Crypted:      file password-protected?
  265.  
  266. Below that:   packer and packratio
  267.  
  268. Orgsize :     original length of unpacked files
  269.  
  270. Crunched:     packed lenght
  271.  
  272.  
  273. Below there is the field for messages of any kind i.e.
  274.  
  275.             - failures
  276.             - responses
  277.             - pack-process
  278.  
  279.  
  280. Progpos :
  281.             - number of the actual entry
  282.  
  283.             - when adding program-steps with multiselect , there
  284.               will be shown how many positions are to insert into script
  285.  
  286.  
  287.  
  288. Script-field for displaying and click-activating the entries - : it shows
  289.  
  290.    result   packmode   packer   ratio   chunksize  flags  filename
  291.      ^                                                ^
  292.      |                                                |
  293.      F (fail = failure appeared)                      |
  294.      R (ready = successful done)                      |
  295.                                                       |
  296.                                                --------
  297.                                                d = delete source
  298.                                                i = copy icon
  299.                                                x = add xpk
  300.                                                c = crypt ON
  301.                                                - = reserved for logfile
  302.                                                - = reserved
  303.  
  304.  (All other chosen values like "SAFE SAVE", "Try-Packer","Copy Comment"
  305.   and so on are valid for the ENTIRE SCRIPT! (ALSO THE PASSWORD!!!)
  306.  
  307.  
  308. For making an entry the ACTUAL one just click on it and then informations
  309. are refreshed given out in the display-fields. With DEL-STEP this entry
  310. can be deleted and WHY_FAIL shows if and what went wrong. Besides this the
  311. original file-path is shown in info-field.
  312.  
  313. New program-steps (like "Load" or changing "Dest Dir") are inserted
  314. BEFORE the actual entry.
  315.  
  316.  
  317.  
  318.  
  319.                 Menues
  320.                 ------
  321.  
  322.  
  323. In menues you can work with MULTISELECT! (= Click and draw)
  324.  
  325.  
  326. Project
  327.  
  328.               Load        like Gadget
  329.               Save        like Gadget
  330.               Save As     like Gadget
  331.  
  332.               About       very important! :-}
  333.  
  334.               Quit        Format all drives -  then destroy the cpu and
  335.                           when ready switch main-power OFF  ;-)))
  336.  
  337.  
  338. Prefs
  339.               Del Source  like Gadget
  340.               Copy Icon   like Gadget
  341.               Add.xpk     like Gadget
  342.               Passwort    like Gadget
  343.  
  344.               PackPri     Packpriority -1 (= Default) or 0
  345.                           Proposal: -1 when working in multitasking
  346.                                      0 when  only XKP-KNIGHT runs
  347.  
  348.               Step Down   set packefficiency lower - useful only when
  349.                           there is lack of RAM (see XPK-Docs)
  350.  
  351.               Lossy OK    (see XPK-Docs)
  352.  
  353.               Safe Save   Save files safely - when machine crashes NO
  354.                           data gets LOST (the original or the new file
  355.                           are still ok )
  356.  
  357.               Verify      BEFORE saving the file there will be checked
  358.                           whether the used xpk.library can unpack that
  359.                           file back to original contition. Only possible
  360.                           together with Safe Save. The most secure way,
  361.                           but needs more RAM.
  362.  
  363.               Comments    take over the comment from original file 1:1
  364.  
  365.               Klick Info  show fileinfos when cklicking on entry in list
  366.  
  367.               Load Prefs  load prefs
  368.               Save Prefs  save the actual prefs
  369.               Set Default prefs to default (= best/safest packmode)
  370.                           That means in singular:
  371.                           - Del Source OFF
  372.                           - Copy Icon ON
  373.                           - Add Suffix OFF
  374.                           - Password OFF
  375.                           - Packpri -1
  376.                           - Step down OFF
  377.                           - "Lossy OK" OFF
  378.                           - Save Safes ON
  379.                           - Verify Safes ON
  380.                           - Copy comments ON
  381.                           - "Klick->Info" ON
  382.  
  383.                           PLEASE NOTE:
  384.  
  385.                           - Pack-choice becomes TRY !
  386.                           - Try-Packers are chosen ALL !
  387.                           - Packmode = Repack (100%)
  388.                           - Chunksize set to DEFAULT (=0KB)
  389.  
  390.               Screenmode  - Opens Screenmode-Requester
  391.                             ATTENTION ! Screen are:
  392.                             MIN: 640*200 - MAX: 724*xxx
  393.                           - GET WB = take over values of Default-Public-
  394.                             Screen
  395.  
  396.        Reset Filereqester - center filerequester to middle of the screen
  397.  
  398. Packer        Choice the wished packers (like gadget)
  399.  
  400.  
  401. Try-Packer   Choice of all packers for Try-Mode (LMB=Multiselect!)
  402.  
  403.  
  404.  
  405.  
  406.                 Trymode
  407.                 -------
  408.  
  409.  
  410.        All Try-Packers will be tested one after the other and
  411.        at at last the best-packing on this file is used.
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.                 Info-Window
  419.                 -----------
  420.  
  421. Displays version and short explaination of packer's peculiarities.
  422.  
  423. These values are taken from the original packers - so I can't garantuee
  424. that they are 100% right. Please read more in the doks of xpk-package.
  425.  
  426. The  info-window is updated each time another Packer/Packratios/Chunksizes
  427. are chosen.
  428.  
  429.  
  430.  
  431.                 Details on executing the program (= scriptmode)
  432.                 --------------------------------
  433.  
  434.  
  435.       - changing the password will NOT be taken over into programm -
  436.         the one given in is valid for the ENTIRE program!
  437.         within the program it only can be switched ON or OFF
  438.  
  439.       - also subsequent changes of Try-Packer-choices will NOT be taken
  440.         over - so in the whole process the ones activated in menu are
  441.         worked with.
  442.  
  443.       - same thing is valid for "Packpri", "Step Down", "Lossy OK"
  444.         "Safe save" and "Copy Comment".
  445.  
  446.  
  447.  
  448.  
  449.                 Hints
  450.                 -----
  451.  
  452.       - For to ABORT just activate the XPK-KNIGHT-window (LMB into it)
  453.         then ONLY ONCE short click RMB and then wait... because:
  454.  
  455.         Aborting is possible only before start, at the end of packprocess
  456.         and when a full chunk is finished. This can last a while - depends
  457.         on the used packer and the chunksize.
  458.  
  459.       - Also the  recursive read-in of a directory can be aborted.
  460.  
  461.       - Delete-protected original files will NEVER (also when "Del Source"
  462.         is active!) be deleted. So see the protection-flag "d".
  463.  
  464.       - If VERIFY is ON, do NOT switch PASSWORD OFF/ON between loading
  465.         and saving!
  466.  
  467.  
  468.  
  469.  
  470.                 Known Bugs
  471.                 ----------
  472.  
  473.  
  474.       - Under Kick 2.0 the script-field gets an additional display on
  475.         the very bottom. There comes the actual entry once  more. The
  476.         script-field (for true its a gadget) is not "ghosted" and can
  477.         still be clicked in in direct-mode.
  478.  
  479.         Under Kick 3.0 and higher the actual entry is highlighed.
  480.         (like I expect it to do).
  481.  
  482.       - Under Kick 2.0 ther can appear problems with screenmodi. Therefor
  483.         only MONITOR-DRIVERS are taken over, which do garantuee a secure
  484.         display. If the actual public screen is not using a Monitor Driver
  485.         the "GET WB" gadget will be ghosted if klicked on it.
  486.  
  487.       - If there are more than 31 packers, in the menu maybe the old
  488.         packer is not disactivated (not un-chosen) because Intuition
  489.         supports this only up to 32 entries. This is only a failure in
  490.         the display which is  corrected immediately after finishing menu-
  491.         selection.
  492.  
  493.       - After packing/depacking in the infogadgets may appear wrong values
  494.         (ratio, size, packer etc.). This is IMHO a problem of the xpkmaster.
  495.         library (V2.4).
  496.         (Even brings up Enforcerhits!)
  497.         Since XPK-KNIGHT V1.05 this bug is corrected by using an internal
  498.         routine.
  499.  
  500.       - Attention: The SQSH-version for 68030-machines crashes 68000-
  501.         Amigas with no mercy! (SQSH or xpkmaster.library (?) do NOT
  502.         catch and prevent this. Maybe other 030-packers act the same.
  503.  
  504.  
  505.  
  506.                 TODO
  507.                 ----
  508.  
  509.       - Logfile
  510.  
  511.       - Ideas und suggestions are welcome.
  512.         See Address below - or simply call Musikbox and leave
  513.         me a letter (mail Sysop)
  514.  
  515.  
  516.  
  517.                 Thanks to:
  518.                 ----------
  519.  
  520. - all the authors of the XPK-package and later xpk-crunchers!
  521.   [Maybe sometime there comes any answer to my E-mails :-)]
  522.  
  523. - reflax (betatest, docfiles (complete englisch docfile!), 68000-icon and big courage ;-) )
  524.  
  525. - Tomato Kid (some betatest)
  526.  
  527. - the authors of Delitracker
  528.  
  529. - all who registered for XPK-KNIGHT till now
  530.  
  531. - all the others I maybe forgot.....
  532.  
  533.  
  534.  
  535.  
  536.                 Address
  537.                 -------
  538.  
  539. Alexander Grossberger
  540.  
  541. Marienburger Strasse 7
  542.  
  543. D-90766 Fuerth
  544.  
  545. Germany
  546.  
  547.                 Email
  548.                 _____
  549.  
  550.  
  551.         nobody@betei.franken.de
  552.  
  553.                 oder
  554.  
  555. Call the Musikbox-BBS: 49(0)911-7593596 and write to the Sysop
  556.  
  557.  
  558.  
  559.  
  560.