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