Re: [AD] Doc for the wfixicon utility

[Laurence Withers <lwithers@xxxxxxxxxx>]

In reply to Eric Botcazou <ebotcazou@xxxxxxxxxx>:
>Could anyone whose mother tongue is English quickly take a look at it ?
>Thanks in advance.

I found it quite difficult to understand the bit about datafiles and
palettes, so I wrote a little example:

--- wfixicon.txt	Sat Dec  1 01:37:38 2001
+++ wfixicon-new.txt	Sat Dec  1 08:48:26 2001
@@ -8,7 +8,7 @@
 
 
 
-The wfixicon utility is an Allegro images to Windows icons converter, that
+The wfixicon utility converts Allegro images to Windows icons, that
 is it lets you convert one or several images in any format supported by
 Allegro into icons suitable to be included in your Windows executable.
 
@@ -24,18 +24,26 @@
    'wfixicon icon [options] bitmap [bitmap...]'
 
 where 'icon' is the icon file to be generated (usually with the standard
-.ico extension) and 'bitmap' are the source bitmaps to be processed.
+.ico extension) and each 'bitmap' is a source bitmaps to be processed.
 
 The general syntax for the second mode is as follows:
 
    'wfixicon icon [options] -d datafile object [palette] [object...]'
 
 where 'icon' is the icon file to be generated (see above), 'datafile' is the
-source from which all objects are taken, 'object' are either bitmaps or RLE
-sprites and 'palette' are palette objects to be used with 8-bit bitmaps.
-You can specify several palette objects, each of them will be associated
-with all 8-bit bitmaps that precede it on the command line and are not
-already associated with another palette.
+source from which all objects are taken, and each 'object' is a bitmap
+or RLE sprite (DAT_BITMAP or DAT_RLE) within the datafile, specified by
+name.
+
+If you have used any 8-bit images, you must also specify a palette. For
+each palette object you include on the command line, any images between
+it and the last palette will be given that palette. For example:
+
+
+   'wfixicon i.ico -d d.dat icon icon2 pal1 tool tool2 pal2'
+
+will give the icons called 'icon' and 'icon2' the palette 'pal1', and
+the icons 'tool' and 'tool2' will be given 'pal2'.
 
 The wfixicon utility accepts the following options:
 

Bye for now,
-- 
Laurence Withers, lwithers@xxxxxxxxxx
                http://www.lwithers.demon.co.uk/

Attachment: signature.asc
Description: PGP signature