home *** CD-ROM | disk | FTP | other *** search
/ Merciful 1 / Merciful - Disc 1.iso / software / a / archivers_collection / archiverscollection.lha / AII / AII.Doc < prev    next >
Encoding:
Text File  |  1993-11-30  |  22.5 KB  |  524 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                DataLine presents
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                             *****      ****    ****
  22.                            **   **      **      **
  23.                            **   **      **      **
  24.                            *******      **      **
  25.                            **   **      **      **
  26.                            **   **     ****    ****
  27.  
  28.                                     v1.35
  29.                              (27th January 1993)
  30.  
  31.  
  32.  
  33.                          Archiving Intuition Interface
  34.  
  35.                             ©1992 by Paul Mclachlan
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                User Documentation
  42.  
  43.                         "Anything that happens, happens"
  44.  
  45.                                         -'Mostly Harmless'
  46.  
  47.  
  48.  
  49.  
  50.                                   INTRODUCTION
  51.                    What is the Archiving Intuition Interface?
  52.  
  53.         The Archiving Intuition Interface, AII, is a specially developed
  54.         workbench program that enables even the novice user to archive and
  55.         de-archive software using most of the various archivers around,
  56.         without needing to learn (or lookup) multitudes of commands, what
  57.         they stand for, and type in line length CLI arguments.  It
  58.         utilises the brilliant ReqTools library, by Nico François as well
  59.         as GadTools.  Until this version this has meaned that AII was only
  60.         useable under KickStart 2.0 or higher.  Starting with this
  61.         release, however, AII will work under KickStart 1.3 just fine.  I
  62.         don't know anyone who has a 1.2 machine, so I cannot test it
  63.         here, but there is no reason why it shouldn't work under this
  64.         early version of KickStart.
  65.  
  66.                               SYSTEM REQUIREMENTS
  67.  
  68.                 o       An Amiga running KickStart 1.3 or higher.
  69.                 o       Some archiving software.  The archivers supported
  70.                         by AII are listed below in the documentation.
  71.                 o       ReqTools.library in your LIBS: Directory
  72.                 o       The execute program in your C: Directory.  This
  73.                         can be found on your 1.3 or 2.x WorkBench disk in
  74.                         the C/ directory on that disk.
  75.  
  76.  
  77.                     NEW FEATURES FOR EXPERIENCED USERS
  78.  
  79.         If you have previously used AII v1.25 or lower, then you will not
  80.         need to read this entire docuemnt.  In fact, you'll probably only
  81.         need to read a few paragraphs, to keep you up with the changes.
  82.  
  83.         Firstly and foremost, the program now works under KickStart 1.3.
  84.         That should be pretty self explanatory.  The reason I'm harping on
  85.         about is because it effectively doubled the size of the source,
  86.         and also doubled the time that I've spent on writing this program.
  87.         By the way, you had better pay your shareware or I'll be really
  88.         annoyed!
  89.  
  90.         Anyway, from 1.25, the archive format .zip has been added.  Umm,
  91.         I'm not so sure which unzip I have used or anything.. btw.. If you
  92.         have an archive program you would like to see supported, then pay
  93.         your shareware and tell me about it.  It'd be nice if you'd tell
  94.         me where I can get it as well, like on which fish disk or which
  95.         SYDNEY bbs...
  96.  
  97.         Umm, two little boxes have been added beneath the two getfile
  98.         gadgets, which show the archive you are working on, or the path
  99.         you wish to restore to.  It does not show multi-files yet as I
  100.         have no idea how I'm going to fit that in without making the
  101.         window MUCH larger.  I don't particularly want to do that.
  102.  
  103.         Oh, the iconify gadget got smaller too, and AII now autodetaches
  104.         correctly if run from a CLI (silly mistake anyhow)
  105.  
  106.         If the most recent version you have used it 1.03, then you will
  107.         also need to read the following:
  108.  
  109.         Firstly, there have been more archiving formats entered.  This
  110.         allows you to archive in lha, lzh, arc, and zoo, and de-archive in
  111.         lha, lzh, arc, zoo, and arj.  You cannot archive in arj as a
  112.         program has not been written that can do it yet.  As soon as one
  113.         comes out, AII will be updated to support it.
  114.  
  115.         Next, there has been a change in the user interface.  Several of
  116.         the gadgets have been moved, and the perform gadget resized.  This
  117.         was done to, uh, make it look better.
  118.  
  119.         A iconify feature has been added, which can be invoked by clicking
  120.         on the title 'button', at the top of the window.  If you can't
  121.         find it, buy some glasses, since its about ¼ of the window big.
  122.         The icon window also remembers its previous position, so you can
  123.         place it where you want it.
  124.  
  125.         Finally, the addition of a Delete file command, enables you to
  126.         delete files while using the program, in case you make an error,
  127.         archiving something you didn't want to or whatever.
  128.  
  129.  
  130.                                   INSTALLATION
  131.  
  132.         To install AII simply click and drag the AII program into a
  133.         suitable directory on your hard drive or system boot disk.  If
  134.         you only have a single disk drive, you may find it more efficient
  135.         to first drag the program onto the RAM: drive, and then from there
  136.         onto your system boot disk.
  137.  
  138.         The actual setting up of the program is made easy by the
  139.         select archiver option in the Project menu.  Simply run the
  140.         program, and then select 'Select Archiver...' from the 'Project'
  141.         menu.  This will bring up several file requesters.  Use these file
  142.         requesters to find the archivers that are specified on your hard
  143.         drive or system disk.  Click on OK when you have found and
  144.         selected this program, or double click on the archiver program
  145.         name.  Now this pathname and setup will be saved to disk in the
  146.         file S:AII.config. If you ever move any of the archiver programs,
  147.         you can easily edit this file or use the method described above.
  148.  
  149.         AII will try to load its config file every time it is loaded, and
  150.         if AII cannot find this file then it will use certain defaults,
  151.         and relys on your system path to allow it to find the program.  If
  152.         you are running from workbench then it is possible that it will
  153.         not find the archiver. It will warn you that it can not load the
  154.         config file with a small requester window.
  155.  
  156.  
  157.                        TROUBLE SHOOTING WITH INSTALLATION
  158.  
  159.         If the program does not work as you expect, then first check that
  160.         your expectations are correct :)  But if you cannot get it to
  161.         work, try some of the following:
  162.  
  163.             o       Ensure that reqtools.library is present in your LIBS:
  164.                     directory.  It is preferable to have a more recent
  165.                     version, such as 36 or higher.  Version 37 or 38 are
  166.                     ideal.
  167.  
  168.             o       Ensure that you have chosen the correct archiver
  169.                     and that it has saved to your disk.  You disk should
  170.                     not be write protected when AII attempts to save its
  171.                     configuration file.  If you are running from
  172.                     workbench, it is especially important that the config
  173.                     is set correctly.  If it is not then there is the
  174.                     possibility of AII not being able to find your
  175.                     archiver!
  176.  
  177.             o       Ensure that the Execute command is either in your C:
  178.                     directory or resident.  Without it AII will find it
  179.                     much more difficult to archive.  (Although it may
  180.                     still manage)
  181.  
  182.             o       The logical device RAM: cannot be write protected.
  183.                     AII uses the RAM: drive as a temporary device.  If you
  184.                     have a disk you have called RAM: in a drive and have
  185.                     write protected it, then AII may or may not manage to
  186.                     perform the operation.  Also under KickStart 1.3, you
  187.                     will need to have the ramdisk.device in the devs:
  188.                     directory.
  189.  
  190.         If all else fails you can contact me at my address at the bottom
  191.         of this file or in the about requester of AII.  If you have paid
  192.         your shareware fee and supply a Self Addressed Stamped Envelope
  193.         than I will reply as quickly as possible.  You can also contact me
  194.         via MAX's net in Australia, if you've paid your shareware.
  195.         Otherwise I'm likely to just tell you to pay it and then maybe
  196.         it'd work :)
  197.  
  198.  
  199.                                      USAGE
  200.  
  201.         Wow, if you've got this far then obviously you really intend to
  202.         read these docs.  Usage is fairly simple, and made simpler by an
  203.         extensive help feature in the program.  Nevertheless, I will
  204.         describe all the features of the program here.
  205.  
  206.  
  207.         PROJECT MENU:
  208.  
  209.             The one and only menu.  There are a few things in here that
  210.             might prove useful.
  211.  
  212.  
  213.             HELP MODE:       HotKey         Amiga h
  214.  
  215.                 By selecting this menu, you can toggle help mode on and
  216.                 off.  This means that it turns help on and off.  Help mode
  217.                 is used by simply turning it on, and then selecting the
  218.                 function that you would like help on.  I think the help is
  219.                 pretty good actually :)
  220.  
  221.             SELECT ARCHIVER:
  222.  
  223.                 This is used to configure the program.  By selecting it
  224.                 you enable a file requester that lets you pick where your
  225.                 various archivers are and what it is called on your hard
  226.                 drive or system disk.  This is then saved in the file
  227.                 S:AII.config.  If the disk is write protected then AII
  228.                 will not be able to save the configuration, and you will
  229.                 be asked to configure the program again next time you load
  230.                 up, until it has written to the disk.
  231.  
  232.             DELETE FILE:
  233.  
  234.                 This brings up a file requester allowing you to delete a
  235.                 file of your choice.  Kinda obvious, huh? (Thats why it
  236.                 wasn't in the 1.25 documentation.. I forgot)
  237.  
  238.             ABOUT:
  239.  
  240.                 Try it and see :)
  241.  
  242.             QUIT:            HotKey         Amiga Q
  243.  
  244.                 This enables you to leave/exit/quit the program.
  245.  
  246.         ICONIFY GADGET:
  247.  
  248.             This gadget has the words 'ARCHIVING INTUITION INTERFACE' in
  249.             it, and doubles as a title and an iconify gadget.  When you
  250.             select this gadget, the window is replaced by a 'title bar'
  251.             size window.  You can return to the original AII window by
  252.             clicking the right mouse button while this window is
  253.             activated.  You can also quit AII in the usual way from here
  254.             by selecting the close gadget.
  255.  
  256.  
  257.         ARCHIVING METHOD GADGET:
  258.  
  259.             This gadget is a cycle gadget.  It cycles through the
  260.             different compression methods that this archiver supports, by
  261.             suffix.   At the moment this gadget supports six methods, .lha,
  262.             .lzh,  .zoo,  .arc,  .arj  and  .zip.   So if, for example, you
  263.             wanted  to  de-archive  'Myfile.lha' then this gadget should be
  264.             set to '.lha' as that is the suffix of the archive.
  265.  
  266.         COMMAND GADGET:
  267.  
  268.             Another cycle gadget, this allows you to select from the
  269.             various forms of commands for the archiver program, such as Add
  270.             Files or Extract files.  The actual functions in these
  271.             commands are all supported by the LHA archiver, which is also
  272.             the most popular archiver around at the moment.  The other
  273.             archivers, however, do not support all of these commands, and
  274.             if you select a command that is not supported by the current
  275.             archiving method, then AII will let you know with a small
  276.             requester.  The commands are:
  277.  
  278.                 ADD FILES:
  279.                     This function allows you to add files to the archive
  280.                     specified.  It will also create a new archive if you
  281.                     specify a non-existant file.  The archive filename
  282.                     that you have selected will appear in the box below
  283.                     the gadget.
  284.  
  285.                 APPEND ARCHIVES:
  286.                     With this command it is possible to concatenate
  287.                     several archives to one or to append several archives
  288.                     to the end of another.  So, if you have 3 archives,
  289.                     and you wish to 'join' them together, then you can use
  290.                     this command.  Specify the destination archive as
  291.                     usual, then, instead of filenames, select archives to
  292.                     concatenate.  If you specify an existing archive as
  293.                     the destination, then the other archives will be
  294.                     appended to this one.
  295.  
  296.                 EXTRACT FILES:
  297.                     With this command it is possible to take a copy of the
  298.                     files in the archive out, and place them in the
  299.                     directory specified.
  300.  
  301.                     Full Path:
  302.                     This extracts the files with their filepaths as
  303.                     well.
  304.  
  305.                 LIST FILES:
  306.                     The various list commands show the contents of the
  307.                     archive, or, if you like, the filenames in the
  308.                     archive.  The higher the level of complexity (short,
  309.                     verbose, full - in that order), the more information
  310.                     is shown about the files.  Try it out on any existing
  311.                     archive.
  312.  
  313.                 TEST INTEGRITY:
  314.                     This command tests the files in the archive, to ensure
  315.                     that they are all complete and proper.  Especially
  316.                     useful if you have downloaded a file and you think
  317.                     some line noise has gotten through, or if you have
  318.                     accidently corrupted a disk.
  319.  
  320.                 FRESHEN FILES:
  321.                     This command can be used to replace older files in the
  322.                     archive with new files from the files selected.  This
  323.                     command never actually adds additional files to the
  324.                     archives, only files that are already present and
  325.                     older will be replaced.
  326.  
  327.                 UPDATE FILES:
  328.                     This performs in exactly the same way as freshen,
  329.                     except that files that are specified and not already
  330.                     in the archive are added as well.
  331.  
  332.  
  333.         CHOOSE ARCHIVE:
  334.  
  335.             This getfile gadget allows you to select the archive that you
  336.             wish to use.  If the archive is new, then simply type the
  337.             archive name in the appropriate space after selecting the
  338.             correct directory.  Otherwise, you can just double click on
  339.             the name or click on the name and then click okay. The archive
  340.             name that you have selected will appear, without its path in
  341.             the box below the gadget.
  342.  
  343.         CHOOSE FILES/PATH:
  344.  
  345.             This getfile gadget changes in function depending on the
  346.             command selected currently.  If you are extracting files then
  347.             you will need to select an output directory for the files to
  348.             go into, and if you are adding, updating of refreshing files
  349.             than you need to specify the files to be used.
  350.  
  351.             Directory selection:
  352.  
  353.                 Simply click your way through the directory levels until
  354.                 you get to the directory that you want to dearchive to.
  355.                 Note that no files will be displayed in the directory
  356.                 requester.  The final directory that you have selected
  357.                 will appear in the box below the gadget.
  358.  
  359.             Multifile selection:
  360.  
  361.                 In this requester, you can select multiple files, either
  362.                 by using the 'all' gadget for all the files visible, the
  363.                 'match' gadget for files matching a certain pattern (see
  364.                 your AmigaDOS manual for more on pattern matching) or by
  365.                 holding down the shift key and clicking on the files that
  366.                 you want to use.  When you have finished and all the files
  367.                 that you want are highlighted, simply click on 'Okay' in
  368.                 the lower left corner.
  369.  
  370.         OPTIONS or the CHECKBOX gadgets:
  371.  
  372.             All of these options are supported by the LHA archiver, but
  373.             many are not supported by the other archivers.  If you have
  374.             selected an option that is not supported, then that will just
  375.             be ignored, and AII will execute the command anyway.  This was
  376.             done because the options are just that, options, and certainly
  377.             not vital to the archive.  If you wish to know what the
  378.             various options mean, you can consult the LHA documentation,
  379.             or the help mode of AII.
  380.  
  381.  
  382.         PERFORM:
  383.  
  384.             This gadget will actually execute the archiver that you have
  385.             selected with the options you have specified.  AII checks that
  386.             you have selected an archive to work on, but not if you have
  387.             selected any files.  After all, not selecting the archive
  388.             crashes the computer, but not selecting files just wastes a
  389.             little time.  Another window will open up, and the archiver
  390.             output will be displayed in there.  When the archiver has
  391.             finished, you can click the close gadget to this window and it
  392.             will disappear.
  393.  
  394. ---------------------------------------------------------------------------
  395.  
  396.         RELEASE HISTORY:
  397.  
  398.             v1.00               Before release
  399.  
  400.                 First version.  Complete with online help
  401.  
  402.             v1.01               Before release
  403.  
  404.                 Fixed a bug whereby the poota crashed if archiving method
  405.                 was not selected.  Thanks to Chris for finding the bug.
  406.  
  407.             v1.02               Before release
  408.  
  409.                 Fixed a bug where the poota crashed if LHA returned a fail
  410.                 code.
  411.  
  412.             v1.03               First release version   20/12/1992
  413.  
  414.                 Fixed a bug where the program could not de-archive to any
  415.                 device ending with a ':'.  Only directories could be
  416.                 de-archived to.  This has now been corrected.  Thanks to
  417.                 Chris for finding the bug.
  418.  
  419.             v1.10               Not released      16/1/1993
  420.  
  421.                 Added several archivers, including arj, pak, zoo and arc.
  422.                 Fixed the bug which didn't allow AII to put its little
  423.                 'operation complete' message at the end of the operation.
  424.  
  425.             v1.20                                 17/1/1993
  426.  
  427.                 Removed pak archiver 'cause it was silly.  Added a
  428.                 delete file menu option.  Fixed the window open bug, where
  429.                 it was trying to open a window with a ':' specified twice
  430.                 in it.  The second one replaced with a '-'.  I think it
  431.                 looks okay.
  432.  
  433.             v1.25                                 17/1/1993
  434.  
  435.                 Added an iconify feature.  By clicking on the title you
  436.                 can iconify the window.  This window also remembers its
  437.                 previous position. It is quite large.. maybe I should make
  438.                 it smaller...nahh.
  439.  
  440.             v1.30                                 20/1/1993
  441.  
  442.                 Added KickStart 1.3 support.  Making cycle gadgets under
  443.                 Kickstart 1.3 is fun.  Added the box to show the selected
  444.                 archive or path.  I'm gonna have to change it later so
  445.                 that if you select multiple files it will show the first
  446.                 or something...  Only released to Chris... I'll be very
  447.                 angry if he spreads it...
  448.  
  449.             v1.31                        21/1/1993 (Early morning)
  450.  
  451.                 Auto detach from CLI... Fixed a few bugs, made the About
  452.                 Requester look prettier.  Actually released this to more
  453.                 than Chris. :)  Should see this version on the great
  454.                 mag, MegaDisc.  If you live in Australia and have never
  455.                 seen it, give the editor a ring on (02) 959-3692.  If you
  456.                 live overseas... well, maybe in a few years :) (eh, Tim?)
  457.  
  458.             v1.32                       21/1/1993 (After some sleep)
  459.  
  460.                 Worked all day to add a 2.0 look to the 1.3 interface.  All
  461.                 the gadgets now look like they are bevelled.
  462.  
  463.             v1.33                       21/1/1993 (Later that night)
  464.  
  465.                 A few minor cosmetic changes.
  466.  
  467.             v1.34                        22/1/1993
  468.  
  469.                 Now AII can be used to archive many things at once, since
  470.                 it 'runs' the archive command.  Also found a bug:  when the
  471.                 program auto-detaches from the CLI, the CLI cannot be shut
  472.                 until the program is.  Umm, pretty awful bug, but its
  473.                 better than AII not detach-ing at all, huh?
  474.  
  475.             v1.35                       27/1/1993
  476.  
  477.                 Umm. Fixed that AutoDetach bug.
  478.  
  479. --------------------------------------------------------------------------
  480.  
  481.         FINALLY:
  482.  
  483.             I have, of course, tried to make this program as easy to use
  484.             as possible.  I feel this documentation is adequate to
  485.             describe the features that are not covered by the help
  486.             function in the program.
  487.  
  488.             Tell me what you think of my program, and send in your
  489.             shareware fee if you like it, huh? Here's my address:
  490.  
  491.  
  492.                                   Paul Mclachlan
  493.                                 60 Hatfield street
  494.                                  Blakehurst, 2221
  495.                                 Sydney,  Australia
  496.  
  497.                                 ph:  (02) 546-1346
  498.  
  499.             Get in touch!
  500.  
  501.  
  502.         DATALINE:
  503.  
  504.             Dataline is a group of Amiga people who got together to
  505.             produce utilties, games and generally programs on the Amiga.
  506.  
  507.             Dataline currently consists of:
  508.  
  509.                 Paul Mclachlan (me)
  510.                 Chris Burton
  511.                 Lee Adamson
  512.  
  513.  
  514.         PROGRAMMERS SIDE-NOTE:
  515.  
  516.                 AII INFORMATION:
  517.  
  518.                     Source Code Total Size:         118776 bytes
  519.                     Compiled under:                 SAS/C v6.00
  520.                     Total Compile Time:             4:10 minutes
  521.                     Final Executable size:          38140 bytes
  522.                     Overall Memory Usage:           74240 bytes
  523.                     Total Size of distribution:     62266 bytes
  524.