home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d09xx / d0933.lha / GuiArc / GuiArc_E.doc < prev    next >
Text File  |  1993-12-20  |  28KB  |  517 lines

  1.           
  2.  
  3.  
  4.                                       GuiArc V1.22
  5.           
  6.                          Graphical User Interface for Achivers.
  7.  
  8.  
  9.  
  10.           1. Copy-rights.
  11.            
  12.           This program is spread as  FreeWare.  It  means  you  may  freely
  13.           distribute and copy this program, as  long  as  everything  stays
  14.           unchanged and all documentation and other files are  spread  with
  15.           it. 
  16.            
  17.           It also means, that this  program  is  Copy-righted  by  me,  the
  18.           author of this program.  You are not allowed to change  anything,
  19.           ask money for the program or use the program commericaly.  Nobody
  20.           but myself is allowed to make money with this program.  This also
  21.           implicates that  this  program  may  not  be  included  with  any
  22.           commercial product without  written  permission  of  the  author.
  23.           This program may be included on  non-commercial  PD  disks  like
  24.           Fish Disks.
  25.  
  26.  
  27.           2. Distribution contents.
  28.            
  29.           The distribution should contain at least: 
  30.                   ArcTypes
  31.                   ArcTypes.info
  32.                   GuiArc
  33.                   GuiArc.info
  34.                   GuiArc_E.doc
  35.                   GuiArc_E.doc.info
  36.                   GuiArc_N.doc
  37.                   GuiArc_N.doc.info
  38.  
  39.           The file 'GuiArcConfig' may absolutely NOT  be  included  in  any
  40.           distribution. When this file is present, the requester  which  is
  41.           shown at the start of the program, will be disabled, and I think
  42.           everybody should see this requester at least one time :-).
  43.  
  44.  
  45.           3. What's the program for.
  46.            
  47.           This program is written, to give you a user friendly and easy  to
  48.           use method of dealing with archivers. The main archiver  where  I
  49.           wrote this program for, is 'Lha'  from  Stefan  Boberg,  but  the
  50.           program is fully configurable  to  use  an  unlimited  number  of
  51.           different archivers at once.
  52.  
  53.           The program recognizes different types  of  archives  automaticly
  54.           from  their  file  pattern.  When  you,  for  example,  select  5
  55.           archives, of different  types,  and  choose  'extract'  from  the
  56.           gadgets menu, all archives will  get  unpacked,  with  their  own
  57.           archiver. The program automaticly selects the  correct  archiver.
  58.           This is also  done  with  all  other  actions,  like  adding  and
  59.           listing. When you create a  new  archive,  and  don't  explicitly
  60.           specify the type, the first defined type (default 'lha') will  be
  61.           chosen.
  62.  
  63.  
  64.           4. How to use the program.
  65.            
  66.           You can start the program from CLI or WorkBench. After  that,  it
  67.           will open a window on the WB-screen, that looks like this:
  68.  
  69.           +--------------------+  +--------------------+
  70.           |                    |  |                    |
  71.           :         A          :  :         B          :
  72.           :                    :  :                    :
  73.           |                    |  |                    |
  74.           +--------------------+  +--------------------+
  75.           |         C          |  |         D          |
  76.           +--------------------+  +--------------------+
  77.            
  78.           +------------+ +-----+  +------------+ +-----+
  79.           |            | |     |  |            | |     |
  80.           |     E      | |  F  |  |      G     | |  H  |
  81.           +------------+ +-----+  +------------+ +-----+
  82.            
  83.            
  84.           The blocks A and B will contain  the  contents  of  the  selected
  85.           directory or archive for the left and right work area.  C  and  D
  86.           contains the path for A and B. They're editable. Blocks E  and  G
  87.           are short-cuts for the paths  C  and  D.  The  right-bottom  most
  88.           gadget of each block is  configurable.  And  at  last,  F  and  H
  89.           contain gadgets for all different actions you can perform on  the
  90.           archives.
  91.  
  92.  
  93.           5. Possible actions.
  94.            
  95.           In this chapter, I will discuss all actions you  can  perform  on
  96.           archives with this program. Therefore,  I  will  first  introduce
  97.           some terms.
  98.  
  99.           The source area is always the block (A or B) whose  contents  are
  100.                used to perform the actions on. If you selected an action in
  101.                F, block A is the source area, and the same with H and B. If
  102.                you selected the action by double  clicking,  the  area  you
  103.                first clicked in, is the source area. 
  104.            
  105.           The target area is the block where the results of the action  are
  106.                placed. This is always the other block. 
  107.            
  108.           The source archive is a selected archive in the source area. This
  109.                can be the source area itself (if you are 'in' a archive) or
  110.                one or more selected archives in the source area. 
  111.            
  112.           Source files are the selected files  and/or  directories  in  the
  113.                source area. This can be files/directories in a directory or
  114.                from the archive you're 'in'. This depends on the action you
  115.                want to perform. 
  116.            
  117.           A target archive is the selected  archive  in  the  targed  area.
  118.                Again, this can be the target area itself (if you're 'in' an
  119.                archive) or exactly one selected archive in the target area.
  120.                If not, the program will ask for the name of a new file. 
  121.            
  122.           Some actions can be activated with an other method than  clicking
  123.           the gadget or  pressing  the  underlined  letter.  This  will  be
  124.           mentioned at the action. An action is always performed  from  the
  125.           source area, to the destination area, or, is case no result  will
  126.           show up, in the  source  area.  These  actions  are  possible  (if
  127.           supported by the archiver, Lha supports them all).
  128.  
  129.           Add  
  130.                With add, you can add files to an archive  (surprise!).  The
  131.                source files are added to the destination archive,  which  is
  132.                created, if nessesary. When a new archive  is  created,  the
  133.                default type is the one of the first defined  archive  type.
  134.                Ofcourse you can  force  the  program  to  use  a  different
  135.                archiver, by adding the right file-extension (or so) to  the
  136.                name.  For  example,  if  you  type  'test',   the   archive
  137.                'test.lha' will be created with 'Lha'  (supposing  'lha'  is
  138.                the first defined type) but,  if  you  type  'test.zoo'  the
  139.                archive 'test.zoo' will be created, with the archiver 'Zoo'.
  140.                This way, you can select all different archivers. 
  141.                You can also start adding files to  an  archive,  by,  after
  142.                selecting the last file to add, clicking in the  destination
  143.                archive within the time of a double-click. You must be  'in'
  144.                the destination archive in the destination area. 
  145.            
  146.           Move  
  147.                Similair to add, but all added files will  be  deleted  from
  148.                the source. This action can not be  activated  in  an  other
  149.                way. 
  150.            
  151.           Ext/Cp  
  152.                Ext means Extract. All selected  source  archives,  will  be
  153.                unpacked and the result will be in the destination area.  If
  154.                you are 'in' a source archive, only  those  files which  are
  155.                selected, will be unpacked. 
  156.                Cp means Copy. This will copy all (non-archive) files and/or
  157.                directorys to the destination area. The  program  uses  the
  158.                cli 'Copy' instruction for  this  action,  so  this  command
  159.                should be  available  in  your  path  (normally  in  the  C:
  160.                directory). 
  161.                You can also activate extract by,  after  you  selected  the
  162.                last  source  archive  (source  file  within  an   archive),
  163.                clicking in the  destination  area  within  the  time  of  a
  164.                double-click. 
  165.            
  166.           View  
  167.                View lets the archiver show you the contents of the  archive
  168.                in an  output  window.   This  action  acts  on  the  source
  169.                archives.  If you select non-archive files and then activate
  170.                'View' (or double-click on  non-archive  files),  the  files
  171.                will be showd, using  the  'File  viewer'  selected  in  the
  172.                Configuration menu (default:  "Sys:Utilities/More"). 
  173.                List can also be activated  by  double  clicking  within  an
  174.                archive or on a non-archive file. 
  175.            
  176.           Test  
  177.                Test acts as if the archive will be extracted, but will  not
  178.                extract. Just to test. All source archives will  be  tested.
  179.                No other activation method is possible. 
  180.            
  181.           Delete  
  182.                Delete will delete  files.  This  can  be  files  within  an
  183.                archive, or plain files or directories. When you are 'in' an
  184.                archive, all selected source files will be deleted from  the
  185.                archive. When you are in a directory, all selected files and
  186.                directories will be deleted from that directory.
  187.                Before the program deletes files or  directories,  it  asks
  188.                your to confirm this deletion, to avoid  unwanted  deletions
  189.                of files. This option can be disabled in  the  configuration
  190.                menu. 
  191.            
  192.  
  193.           6. The menu's.
  194.            
  195.           The program has only three menu-items. 'Quit' is easy.  It  quits
  196.           the program (same as the close gadget).  'About'  will  give  you
  197.           some 'on-line' information about the program.
  198.  
  199.           And finaly, 'Configure' lets you adjust  some  things  about  the
  200.           program. You can ajust: 
  201.              - The path-short-cut gadgets  at  the  bottom  right  of  both
  202.                blocks, can be adjusted. You can type in your own  name  and
  203.                path. 
  204.              - When the program  starts,  both  areas  can  be  automaticly
  205.                filled with the contents of an archive or directory. You can
  206.                give in these default paths/archives here.  When  you  leave
  207.                this empty, nothing is read. 
  208.              - The viewer  used  for  viewing  non-archive  files,  can  be
  209.                entered in the 'File viewer' gadget. Please,  use  the  full
  210.                path and name of the viewer. 
  211.              - The next to gadgets let you disable the confirmation  before
  212.                deletion of files from archives or of files and  directories
  213.                from directories. 
  214.              - The gadget 'Archive flags' will bring you to a window  where
  215.                you can (de)select eleven options for the  archivers.  These
  216.                options are specific for Lha, but some other archivers  also
  217.                support them. 
  218.                When you  select  'OK',  the  flags  are  active.  Selecting
  219.                'Cancel' in the configuration windown, will not  cancel  the
  220.                flag settings. 
  221.              - With the gadget 'Save' you can save the settings to the file
  222.                'GuiArcConfigure', which is located in the same directory  as
  223.                the program. 
  224.            
  225.  
  226.           7. Different types of archive(r)s.
  227.            
  228.           As mentioned before, the  program  is  able  to  deal  with  many
  229.           different  file  archivers.  You  can  configure   the   diffente
  230.           archivers, by editing (or creating) the file 'ArcTypes', which is
  231.           placed  in  the  same  directory  as  the  program  itself.   The
  232.           distribution of the program, contains  an  'ArcTypes'  file  with
  233.           definitions for: Lha 1.42, Zoo 2.1 Beta, Ape 1.35 and  Arc  0.23.
  234.           Unfortunately, Zoo is very bad programmed. So bad, it isn't even
  235.           possible to redirect it's output to an anther file, and thus  you
  236.           can't enter the archive by double clicking it.  With  all  other
  237.           archivers, this is possible, and I think, this is the strength of
  238.           GuiArc! 
  239.           I think the settings will do for new versions of these archivers,
  240.           however, you can change them yourself easily. The description  of
  241.           the 'lha'  type  below,  is  integrated  in  the  program.  These
  242.           settings are used when the file 'ArcTypes' can't be found.
  243.           The  format  of  the  'ArcTypes''s  archiver's  descriptions   is
  244.           described below.
  245.  
  246.           Each entry MUST exist of ALL of the fields described  below,  and
  247.           in THAT order.  Lines  starting  with  a  semi-collon  (';')  are
  248.           considered comments, and  are  ignored.  Inline  comments  aren't
  249.           possible. Empty lines are ignored. Before each new type-name, you
  250.           must place a '@'.  This  is  character  is  used  to  synchronise
  251.           everything. In this way, it's easier  to  locate  errors  in  the
  252.           configuration file. 
  253.           The %s in the command line, will be substituted with the  choosen
  254.           options in GuiArc, preceded by a '-'. Note that not all archivers
  255.           support these options. The flags are given as  'lha'  flags.  (So
  256.           generally this options are only use-full with 'Lha'...)
  257.  
  258.           Example configuration for Lha:
  259.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  260.           @LHA                    '@' + Name, max. 5 characters
  261.           #?.(lha|lzh)            Recognizion file pattern.
  262.           lha %s x                Command to unpack the archive
  263.           lha -2Y %s u                ,,  to add files
  264.           lha -2Y %s m                ,,  to move files into the archive
  265.           lha v                       ,,  to list the archive
  266.           lha t                       ,,  to test the archive
  267.           lha d                       ,,  to delete files from the archive
  268.           lha v                       ,,  to list files for 'entering'
  269.           -1                      Lines to skip at the top of the listing.
  270.           -1                      Lines at the bottom of the listing
  271.           44                      Start position of names on the line
  272.           0                       End position of names on the line
  273.            
  274.            
  275.           Whenever a command is not available, place a '-' on the line  (no
  276.           spaces before or after the '-'!)  If  you  want  to  be  able  to
  277.           'enter' an archive, the last command and the 4  offsets  must  be
  278.           available. The program uses these to filter the file names out of
  279.           the archive list. Lines starting with a  ':'  are  ignored.  Most
  280.           archivers (at least, lha) use this to indicate a file-comment.
  281.  
  282.           If you use a negative number as top or bottom skip,  the  program
  283.           skips all lines before/after a line which starts with a '-'  or  a
  284.           '='. This is very usefull for archivers who use lines of  '-'  or
  285.           '=' to indicate the start of the file list.  You  don't  have  to
  286.           count lines, and the program will be able to deal with a variable
  287.           number of lines before/after the file list  (for  example,  error
  288.           texts or something like that).
  289.  
  290.           When you enter a 0 for the end position of the file name  on  the
  291.           line, the program assumes the name of the file ends at the end of
  292.           the line. Always use this, if the file name is placed at the  end
  293.           of the line in the file list.
  294.  
  295.           Note that when files can't be entered due to the specification of
  296.           the archiver (yet only  Zoo  is  strugling,  but  that's  nog  my
  297.           fault) you're  still  able  to  perform  all  actions  on  the
  298.           archive, except deleting files from the archive.
  299.  
  300.  
  301.           8. General information and something about the PATH.
  302.            
  303.           To create some work-space on the workbench screen, without having
  304.           to quit the program, I've made it possible to  iconify  it.  When
  305.           you press the 'Help'-key or the 'I'-key, the program will  become
  306.           in-active,  closes  the  window  and  create  an  'icon'  on  the
  307.           work-bench. A double click on the icon  will  bring  the  program
  308.           back on the screen in it's original state. No buffers are cleared
  309.           on iconifying.
  310.  
  311.           It is very important, that the archivers you use, can be  reached
  312.           by the program.  Therefore,  be  sure  the  directory  where  the
  313.           archivers are placed is added in the PATH of the program. C: will
  314.           be a fine place to put the archivers. 
  315.           If, for one or another reason, it is  not  possible  to  add  the
  316.           right dir to the path, you can enter the  full  path  before  the
  317.           name of the archiver in the configuration file. However, this  is
  318.           not the best way to do this, since the available  space  for  the
  319.           commands in the configuration file is limited to 30  characters.
  320.           If you use this method, don't use  relative  paths,  because  the
  321.           program switches internally between directories.
  322.  
  323.            
  324.  
  325.           Some characters in the gadgets, are underlined. These can be used
  326.           as short-cut for that specific item. I've arranged them in such a
  327.           way, that you can use them best if you leave all your archives in
  328.           the left area, and every thing else in the right area.
  329.  
  330.           And last, but not least: In case you  haven't  discovered  it  by
  331.           now, by double  clicking  on  an  archive,  you  can  enter  that
  332.           archive, as if it was a directory! (That is, if it  can  be  done
  333.           with the archiver you use.)
  334.  
  335.           I would like to thank: 
  336.              - Marcel  Duyn,  for  testing  the  program  and  reading  the
  337.                documentation and editing/correcting it. 
  338.              - Frank Sloep, for testing the program. 
  339.              - Jan van den Baard, for writing the program GadToolsBox. 
  340.              - Michiel Willems, for providing the nessecery  utilities  and
  341.                information trough  his  BBS  (Amiga  Bs  Online  Heemstede,
  342.                +31-23-282002), connecting me to the  different  mail-areas,
  343.                coming with idea's and discouraging me in this project  :-((
  344.                (at least, at the beginning) and for editing/correcting the
  345.                documentation.
  346.              - Marcel Offermans for testing, providing new idea's and  some
  347.                system information. 
  348.              - Winston Vakkers for his (little) bug-report. 
  349.              - CSA, for manufacturing the Derringer! 
  350.              - The brewers of Arcener tarwe white beer, Duvel and Maredsous
  351.                and of course the Amstel beer brewer :-)) 
  352.              - And of course all coders of those great file archivers! 
  353.            
  354.            
  355.           Changes in version 1.01: 
  356.  
  357.              - Extended the line-buffer for 'entering' an archive from  100
  358.                to 256 characters. Pretty handy for looooong paths... 
  359.            
  360.            
  361.           Changes in version 1.10: 
  362.  
  363.              - The 'Delete' function know also works  on  plain  files  and
  364.                directories. 
  365.              - With the 'Ext/Cp' funtion, it now is posible to  copy  files
  366.                and directories. 
  367.              - With the 'View' option, you now can vies archives and  files
  368.                (for example those 'ReadMe' files). 
  369.                (Remark: Despite the above options, this program is and  has
  370.                been an util to handle archivers. Therefore, the  posibility
  371.                to handle plain files, will be restricted.) 
  372.              - It has made easier to select multiple files and directories,
  373.                by holding down the left mouse button during selection,  and
  374.                moving the mouse up and/or down. 
  375.              - When changing the active path in a  scroller,  or  rereading
  376.                the scroller after some actions, the current position of the
  377.                scroller, will be kept as much  as  possible.  (An  idea  of
  378.                Marcel Duyn.) 
  379.              - If you enter an empty path for a scroller (or click  on  the
  380.                'Drives' gadget), a list of available  volumes  and  assigns
  381.                will be shown. (An idea of Michiel Willems.) 
  382.              - Optimized the internal structure of the  program.  This  has
  383.                made  the   program   relative   smaller   and   easier   to
  384.                exetend/adjust. 
  385.            
  386.            
  387.           Changes in version 1.15: 
  388.  
  389.              - Made scrollerbars 8 pixels smaller and added the room to the
  390.                list-view, so one more character can be displayed :-)) Gives
  391.                a nicer look. 
  392.              - Fixed the ugly look when you  used  a  "default  screentext"
  393.                other than 8 pts. topaz. 
  394.              - Fixed the 'text-mixing' if  you  chainged  the  configurable
  395.                gadgets when you worked on a screen smaller than 256  pixels
  396.                high. 
  397.              - Fixed  the  placing  of   the   string-requester   and   the
  398.                output-window, when you work on BIG WorkBenches. 
  399.              - Changed the system-requester style  about  requester,  to  a
  400.                custom-made one with a kind of a logo. This one will  pop-up
  401.                every time the program is executed. You can  disable  this,
  402.                by selecting 'Configure' in the menu  and  then  select  the
  403.                'Save' gadget. 
  404.              - Improved the control possibilities on the external commands,
  405.                using the new dos System  function,  in  stead  of  the  old
  406.                Execute function. 
  407.            
  408.           Changes in version 1.22: 
  409.  
  410.             - Nicer looking menu's under 3.0 (so they told me, I haven't got
  411.               3.0 (yet) so I can't check this).
  412.             - Usage of file-requesters (asl) in the configuration menu.
  413.             - Split the configuration into two separate menu items.
  414.             - Separate saving option for the configs, with a check at
  415.               'quit', if the config has been changed.
  416.             - All 2x6 drive gadgets are now configurable (many people asked
  417.               for this).
  418.             - Command-line and icon-tool options (PUBSCREEN, ICONIFY, ICONX
  419.               and ICONY) added.
  420.             - Public screen support (through the PUBSCREEN option).
  421.             - Removed a minor bug in the default ArcTypes in the code itself.
  422.             - Added a iconify option in the menu and removed the Help key as
  423.               short-cut for iconify (it confused some people).
  424.             - The iconify-icon now is a real icon and no longer a window.
  425.             - After a call to the 'viewer', the question 'Pres...' is no
  426.               longer asked.
  427.             - When you reach the upper or bottom of the scroller, during a
  428.               drag select, the scroller will scroll automaticly.
  429.             - The 'delete' option now is also capable of deleting not-empty
  430.               directories. However, it will first ask you. It uses the CLI
  431.               instruction 'Delete' for this, so it should be present in you
  432.               C: directory.
  433.             - The Path's below the scrollers will now provide you with better
  434.               information. If you, for example, type in "df0:" and in drive
  435.               "df0" is a disk named "GreatProgramGuiArc", then the Path will
  436.               show "GreatProgramGuiArc:" in stead of the old "df0:".
  437.             - Removed a minor bug in the WB startup handling code which caused
  438.               the program to hang when started from ToolsManager under WB mode.
  439.             - Added basic support for DMS. That is; paking and unpacking of
  440.               entire disks and viewing and testing the archives. Track
  441.               selecting is nog supported.
  442.             - Fixed a bug that occured when the command-line to be executed
  443.               became to long for Dos.
  444.             - As with version 1.22, GuiArc has a Hot-key, implemented with the
  445.               commodities system. The default key is the Enter key on the
  446.               numeric key pad. You can configure this with the option of
  447.               tool-type HOTKEY. See also the file "HotKeyHelp" for more info
  448.               about hot-keys. The hotkey does always work (iconified program
  449.               or not). When it is not possible to place an icon on the
  450.               WB-screen, but the hot-key is initialized correctly, the window
  451.               will close. The functions Enable, Disable and Kill of the
  452.               WB programm Exchange will also 'pop-up' the application.
  453.             - The loading and saving of the config file has changed. The
  454.               defaults know are env: (when you select 'use') and envarc:
  455.               (when you select 'save'). The saved file is called GuiArc.Prefs.
  456.               The program will still search for the file GuiArcConfig in the
  457.               program directory and will also save it there if found there.
  458.               So changing to the env: and envarc: system, as described below,
  459.               isn't necessary. You can also specify your own settings with
  460.               the keyword or tool-type SETTINGS. Using an settings file with
  461.               icon, is also possible (see example).
  462.               To fully change to the env: and envarc: method, when you already
  463.               have your own saved config, you should:
  464.                * Start GuiArc.
  465.                * Type in one of the Path gadgets: PROGDIR:
  466.                * Select the file "GuiArcConfig" and remove it with "Delete".
  467.                * Select "Configure" in the menu.
  468.                * Klick on the gadget "Use".
  469.                * Quit GuiArc by selecting "Quit" in the menu. Answer the
  470.                  requester with "Quit" and NOT with "Save"!
  471.                * Start GuiArc again and select "Save settings" in the menu.
  472.               If your system had the env: and envarc: stuff installed corectly,
  473.               GuiArc from now on will work with them.
  474.  
  475.  
  476.           I also added file notification support on the ArcTypes file. This
  477.           means, that if you change this file, the program will be notified
  478.           by the system, and reread the file. This way, you don't have to
  479.           restart the program every time when you changed the ArcTypes
  480.           file. However, my OS (2.0) doesn't support notification fully, so
  481.           I haven't been able to test this. It will probably not work (but
  482.           took that less code, I let it in). If it works on your system, be
  483.           happy and let me know.
  484.  
  485.  
  486.           9. And finaly.
  487.            
  488.           I made this program as part of my hobby. That's why its FreeWare,
  489.           and why I absolutely do not ask you for any share in  the  costs.
  490.           But I would like to know if you like this program, and  how  many
  491.           people like it. So, if you like it, please let me know by sending
  492.           me a post-card or net-mail or something like that.   Ofcourse  in
  493.           case you like the program so  very  much,  and  want  to  make  a
  494.           donation, you're welcome!  :-)) And I  do  appreciate  eventually
  495.           bug reports.
  496.  
  497.           You can reach me at the address below (  although  I'm  doing  my
  498.           military duty for the rest of this year (1993) so  I'm  only  the
  499.           weekends at home... :-((( )
  500.  
  501.            
  502.  
  503.           Fido: 2:280/464.2 or Amy: 39:151/1.2 or
  504.            
  505.           Patrick van Beem
  506.           Parlevinker 5
  507.           2152 LC  Nieuw-Vennep
  508.           The Netherlands
  509.            
  510.            
  511.           ⌐ Februari, April, May 1993 by,
  512.             _             _
  513.            /_)           /_)
  514.           /  atrick van /_)eem
  515.  
  516.  
  517.