@database "IconUpdate Documentation"
@author "Martin Huttenloher"
@(c) "Copyright Š 1994 Martin Huttenloher"
@$VER: IconUpdate Documentation 1.1 (30-Jun-94)

@node main "Welcome to IconUpdate"


                              IconUpdate 1.6
                              ==============

        Copyright Š 1993-94, by Gerri Körner and Martin Huttenloher

            - Only distributable in conjunction with MagicWB -


                           1.@{" INTRODUCTION  " link intro}
 
                           2.@{" USAGE via WB  " link useWB}
  
                           3.@{" USAGE via CLI " link useCLI}

                           4.@{"    AUTHORS    " link authors}

                           5.@{" DISTRIBUTION  " link distri}


@endnode
@node intro

  1. INTRODUCTION
  ---------------

  When copying an icon over another with the simple 'copy' command, the
  destination icon will be completely replaced by the source icon. No
  information will be preserved. That's the reason why we equipped MagicWB
  with this versatile and easy-to-use program.

  IconUpdate provides you with a very comfortable way of only copying the
  images of one icon to another while preserving the information of the
  original icon. This information can be the STACK size, the TOOLTYPES, the
  DEFAULT TOOL, the original ICON POSITION and the original WINDOW POSITION
  of icon-types like Trashcan, Disk and Drawer.

  With this command you won't need IconEdit anymore for tasks like converting
  an old icon to a new MagicWB-Icon. It will be faster by using this command
  and you won't have problems with bugs in IconEdit (like the IconEdit3.0
  bug, when loading 'both images' from an icon and saving it, IconEdit saves
  the whole icon area, giving the icon the maximum border on the WB though
  the icon image may be much smaller).

@endnode
@node useWB "Usage"

  2. USAGE via WB
  ---------------

  If you activate IconUpdate via the Workbench by clicking onto its icon
  an app-window will pop up. Follow the instructions which are given to you
  in the window title. It's very easy to use: First, drag and drop the
  source (MagicWB) icon onto the app-window. You will then see the icon
  centered in the window. Second, drag and drop the destination (old) icon(s)
  onto the app-window. IconUpdate will then convert the old icon(s) to the
  new MagicWB icon.

  The destination icons can be as many as you desire. If you want more than
  one icon to be replaced with the source MagicWB icon, just multiselect
  these old icons by holding down the SHIFT key and drag all icons to the
  app-window while still holding down the SHIFT key. When you drop them, be
  sure that the mouse pointer is WITHIN the app-window. All icons which
  overlap the app-window while dropping the multiselected bunch of icons onto
  the app-window will also be processed. So, you won't need to adapt the
  size of the app-window to the size of the multiselected icon-bundle. Just
  care that the mouse pointer is located within the window when dropping them.

  REMARK: The signature "ťťťť Icon by Martin Huttenloher ŤŤŤŤ" won't be
          added to the icon's tooltypes list if you use the app-window.

@endnode
@node useCLI "Usage"

  3. USAGE via CLI
  ----------------

  The command line for IconUpdate is:

           ICONUPDATE <T|C|S|D|W> <FROM[.info]> <TO[.info]>

  The flags mean:

  <T> = Preserve TOOLTYPES of original icon
  <C> = Preserve SNAPSHOT POSITION of original icon
  <S> = Preserve STACK SIZE number of original icon
  <D> = Preserve DEFAULT TOOL entry of original icon
  <W> = Preserve WINDOW POSITION of original icon (drawer, disk, trashcan)

  You may just use one flag or all flags, just at will. The order is also
  not important, which means you can mix the flags.

  These two arguments are obligatory:

  <FROM[.info]> = MagicWB-Icon  (you may or may not use the .info extension)
  <TO[.info]>   = old Icon  (use of .info extension as you like)


  Feature: IconUpdate is PURE. So you can make it RESIDENT.


                             @{" Example " link example}
@endnode
@node Example

  Example:
  --------
              IconUpdate ctd NewIcon.info OldIcon.info

  This will copy the new icon image over the image of the old icon,
  preserving the position, the tooltypes and the default tool entry of the
  old icon. The stack size and the window position (only necessary if the
  destination icon is either a drawer, disk or trashcan icon) will not be
  preserved because the S- and W-Flag were not set. Thus the stack and
  window position information of the old icon will be replaced by those of
  the source (new) icon.

  I think it should be rather clear now how to use this command.

@endnode
@node authors "Authors"

  4. AUTHORS
  ----------

  Gerri Körner

  Martin Huttenloher

  additional help by Martin Korndörfer and Stefan Stuntz :-)


  If you come across any bugs, please drop me a note.

  Use my EMail or (if necessary) my snailmail addresses (described in the
  documentation of MagicWB) for bug reports.

@endnode
@node distri "Distribution"

  5. DISTRIBUTION
  ---------------

  As IconUpdate specifically processes MagicWB-Icons and was programmed for
  the use with MagicWB it should only be used if converting an old icon to
  a MagicWB-Icon.

  Therefore it is only allowed to be distributed in conjunction with MagicWB!

@endnode