Document StripIcon Release 1.4 documentation


                            
                          STRIPICON 1.4

 Removes redundant bitplanes from icons created with Commodore's
 IconEdit, e.g. the icons distributed within the `MagicWB'
 package.

                   © by Timm Müller 1993/1994


0. Disclaimer
=============

                           Disclaimer
                           ----------

 This software may be used and redistributed freely, as long as
 there are no changes made to the program, its source code, and
 its documentation. The `author' makes no guarantee of any kind
 for the reliability of the software described in this
 documentation.


1. Introduction
===============

                           Introduction
                           ------------

 StripIcon is a simple shell command that removes redundant
 bitplanes from Workench icons that are sometimes created with
 Commodore's IconEdit.

 I always wondered why the icons distributed with the `MagicWB'
 package occupy that unnaturally much diskspace. So I decided to
 analyze those icons' structure and found out that they're
 containing image data in eight bitplanes, although they're making
 use of eight colours only.

 The reason is: Mr Huttenloher -the author of `MagicWB'- used
 Commodore's IconEdit for creating these icons, and IconEdit works
 with eight bitplanes internally. After introducing the AGA
 chipset and starting with OS3.0, the Workbench may run with up to
 256 colors. That leads to the problem that icons on a 256 color
 Workbench have to keep image data in eight bitplanes in order to
 display correct colors.

 If you've got a Workbench with 256 colors, you should keep the
 `MagicWB' icons unchanged, otherwise their colors become
 corrupted. If you're using less, you may strip the `MagicWB'
 icons to the number of bitplanes that is used by your Workbench,
 in order to reduce chipmem and harddisk usage and to speed up the
 icon display. Keep in mind that you should NOT strip any icons to
 less bitplanes than your Workbench makes use of! Only if your
 Workbench also has got 3 (three!) bitplanes, you can strip the
 `MagicWB' icons to the very minimum. At this point I have to
 apologize to Martin Huttenloher, for I asserted that he used a
 "buggy" feature of IconEdit. This assertion, stated in an earlier
 version of StripIcon, was definitely WRONG, for IconEdit is not
 buggy and Martin did it the right way, due to the color problems
 mentioned above. Thanks to Martin who explained me this in quite
 a long phone chat.

 By the way: You may of course use StripIcon not only for
 `MagicWB' icons, but for your own icons as well.


2. Documentation
================

                          Documentation
                          -------------


2.1. System requirements
------------------------

                       System requirements
                       -------------------

 You need Kickstart 2.0 or higher to run StripIcon.


2.2. Shell usage
----------------

                           Shell usage
                           -----------

 Template:           StripIcon ICON/A,DEPTH/N/K

 You must specify an icon for input, whereby it makes no
 difference whether or not an .info suffix is added to the
 filename.

 Optionally you may specify the DEPTH keyword, followed by the
 number of bitplanes you want that icon to be stripped to. The
 default DEPTH setting is 3, which corresponds to `MagicWB''s
 icons.

 You can make StripIcon resident if you like. This will improve
 speed considerably.

2.3. DirectoryOpus installation
-------------------------------

                   DirectoryOpus installation
                   --------------------------

 It is highly recommended to configure a STRIPICON button or menu
 inside of `DirectoryOpus', especially if you're having the
 complete `MagicWB' icon set installed to your system.
 Installation example:

                   AmigaDOS   c:StripIcon {f}

            Flags: Do all files, Recursive Directories.

 You may then use StripIcon on whole partitions without any risk.
 Only real icon files are changed. You may even rename your
 startup-sequence to xxx.info, it won't be touched. Be careful if
 you're using icons with more than eight colours.


3. Further MagicWB speedup
==========================

                     Further MagicWB speedup
                     -----------------------

 Using StripIcon, you will gain a general speedup when working
 with `MagicWB' icons on your Workbench. But there are still two
 more possibilities to improve speed.


 - Always fix the icons' positions in a specific directory. Just
 drag-select multiple icons, then choose "Icons/Snapshot" from
 your Workbench menu.

 - Next time you're cleaning up your hard disk partition, consider
 using the well-known disk optimizer `Reorg'. This utility offers
 various possibilities to configure the optimization process. Use
 the option "Workbench Mode". This will increase speed drastically.

4. Author
=========

                             Author
                             ------

 Don't hesitate to contact the author if you've got problems, ideas
 for enhancements, bug reports or something like that.


                         Timm S. Müller
                        Wehrdaer Weg 3/39
                          35037 Marburg
                          FR of Germany
                        Tel. 06421-63828

5. Revision History
=================== 

                        Revision History
                        ----------------



    v1.2      First public release

    v1.3      internal release

    v1.4      Minor code clean-ups performed

              Removed a very serious mistake in the
              documentation. Mr Huttenloher's address
              was wrong - I inserted MY OWN address
              by mistake.



6. Acknowledgements
=================== 

                        Acknowledgements
                        ----------------

6.1. MagicWB
------------


        MagicWB is shareware and © by Martin Huttenloher.
            To get registered, send DM20,- or $20 to

                       Martin Huttenloher
                         Am Hochsträß 4
                           89081 Ulm
                          FR of Germany


6.2. DirectoryOpus
------------------


              DirectoryOpus is © by Jonathan Potter
                      and is distributed by

                        INOVATronics GmbH
                       Lütticher Straße 12
                      53842 Troisdorf-Spich
                          FR of Germany
                        Tel. 02241-406856
                        Fax. 02241-406773

6.3. ReOrg
----------

                     ReOrg is shareware and
                        © by Holger Kruse


                          Holger Kruse
                        12006 Coed Drive
                        Orlando, FL 32826
                               USA

6.4. Ralf Thanner
-----------------


 Thanks to Ralf Thanner who urged me on writing this. 

