@database "IconUpdate Documentation" @author "Martin Huttenloher / Gerri Körner" @(c) "Copyright © 1993 Martin Huttenloher" @$VER: IconUpdate Documentation 3.0 (27-Dec-93) @node main "Welcome to IconUpdate" IconUpdate 2/3 ============== Copyright © Sept 1993, by Gerri Körner - Freely distributable - 1.@{" INTRODUCTION " link intro} 2.@{" USAGE via CLI " link useCLI} 3.@{" USAGE via WB " link useWB} 4.@{" CREDITS " link credits} 4.@{" AUTHOR " link author} 6.@{" DISTRIBUTION " link distri} 7.@{" HISTORY " link history} @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 command. 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). As this version of IconUpdate is not tied to MagicWB anymore, you can use it for your own projects as well. See @{" DISTRIBUTION " link distri} for details. Kickstart 2.x or higher required !! @endnode @node useCLI "Usage" 2. USAGE via CLI ---------------- The command line for IconUpdate is: ICONUPDATE The flags mean: = Preserve TOOLTYPES of original icon = Preserve SNAPSHOT POSITION of original icon = Preserve STACK SIZE number of original icon = Preserve DEFAULT TOOL entry of original icon = 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: = new Icon (you may or may not use the .info extension) = old Icon (use of .info extension as you like) Feature: IconUpdate20 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 useWB "Usage" 3. USAGE via WB --------------- You activate IconUpdate via the Workbench by clicking onto its icon 'IconUpdate30'. Read the section @{" USAGE via CLI " link useCLI} and you should be familiar with the possibilities presented by the GUI. There are two ways to enter the from/to name: - using the string gadget - by clicking on the disk gadget, which opens a requester The preserve flags can be set/unset by clicking on the checkmark next to them. Click on the start button to invoke the update procedure. Its really easy to use, isn´t it ? HINT: - If you use the from and to requester, it is not opened in the same directory. This should it make easier to update multiple Icons in different drawers. - you can also use IconUpdate30 from CLI, but you CANNOT make it RESIDENT. @endnode @node credits "Credits" 4. CREDITS ---------- Martin Huttenloher ( initiator, comments, bug reports, MagicWB ) Martin Korndörfer ( additional programming help ) Jan van den Baard ( GadToolsBox, a really great utility ) Matt Dillon ( DICE ) @endnode @node author "Author" 5. AUTHOR ---------- If you have any bug reports, comments, suggestions or if you want to include IconUpdate in your own package, here is my adress: E-Mail: s_koerner@rzmain.rz.uni-ulm.de Snail-Mail: Gerri Körner Kulturenweg 6 87642 Buching Germany @endnode @node distri "Distribution" 6. DISTRIBUTION / WARRANTY -------------------------- IconUpdate 2.0/3.0 is freely redistributable as far as all files in this package are kept together. If you want to include IconUpdate in your own package, you must send me a short note. I can and will not be held responsible for any damages which are caused directly or indirectly by IconUpdate. Use at your own risk ! @endnode @node history "History" 7. HISTORY ---------- v1.0 written 16-Sep-93 by Gerri Körner v1.1 written 17-Sep-93: - with or without .info extension possible v1.2 written 18-Sep-93: - cosmetic changes v1.3 written 20-Sep-93: - W flag added v1.4 written 21-Sep-93: - rearranged code ( THANK YOU MaKo for your invaluable help ) - up to 200 tooltypes can be processed now »»» separated development from Martin Huttenloher ««« v2.0 written 23-Sep-93: - IU analyses if the signature already exists: If so, it won't add another signature to the tooltype entries, thus avoiding multiple signatures in one icon (and saving space) - cosmetic changes v2.1 written 24-Sep-93: - WB/FileReq support - Requester Mode added v2.2 written 29-Sep-93: - splitted into several Modules - added / to current_dir (bug removed) v3.0 written 29-Sep-93: - GUI added - Dice only @endnode