Updated include-file define name to match file name.
[AROS.git] / tools / ilbmtoicon / README
blob829af80d933a58f2fee044782b0c95ab5929a0b8
1 ilbmtoicon
3   converts one or two ilbm image files into an amiga icon file
4   which will contain both old style (pre 3.5) image data and
5   new style image data (IFF ICON attached at the end).
6   
7   can also convert one or two png image files into a PNG icon
8   file (normal PNG image with an extra icOn chunk). If two
9   PNG images are specified, the resulting .info file will simply
10   result in both images being joined together.
11   
12 usage
14   ilbmtoicon DESCRIPTIONFILE IMAGE1 [IMAGE2] outfile
15   
16   If two images are specified, both must be of the same file
17   format, ie. PNG or ILBM. The image format determines whether
18   an Amiga style icon (ILBM) or a PNG style icon (PNG) will be
19   created.
20   
21 icondescription file
23   Is a text file which should be named ICONNAME.info.src.
24   If the specified file does not exist this is silently ignored.
25   
26   It can contain the following options in the form of
27   KEYWORD = KEYVALUE. 
28   
29    TYPE = (DISK|DRAWER|TOOL|PROJECT|GARBAGE|DEVICE|KICK|APPICON)
30    
31      Icon type. Optional. Default is TOOL. Not necessary/useless
32      when making a PNG icon, because there the icon type is not
33      stored, but guessed automatically when loaded by icon.library.
34      
35    DEFAULTTOOL = <string>
36    
37      Optional.
38     
39    STACK = <integer>
40    
41      Stack. Optional. Default is 4096.
43    TOOLTYPE = <string>
44    
45      Can be used multiple times. Optional.
46          
47    ICONLEFTPOS = <integer>
48    
49      X Position of icon. Optional. Default is 0x80000000 (NO_ICON_POSITION).
50      
51    ICONTOPPOS = <integer>
52    
53      Y Position of icon. Optional. Default is 0x80000000 (NO_ICON_POSITION).
54      
56    DRAWERDATA = <anystring>
57    
58      Attach DrawerData struct to Icon. Optional.
59    
60    DRAWERLEFTPOS = <integer>
61    
62      X Position of Drawer Window. Optional.
63       
64    DRAWERTOPPOS = <integer>
65    
66      Y Position of Drawer Window. Optional.
67      
68    DRAWERWIDTH = <integer>
69    
70      Width of Drawer Window. Optional.
71      
72    DRAWERHEIGHT = <integer>
73    
74      Height of Drawer Window. Optional.
75      
76    DRAWERVIEWLEFT = <integer>
77    
78      X View Position of icons inside drawer window. Optional.
79      
80    DRAWERVIEWTOP = <integer>
81    
82      Y View Position of icons inside drawer window. Optional.
83      
84    DRAWERSHOW = (DEFAULT|ICONS|ALL)
85    
86      Show icons only for files having icons or for all files.
87      Optional. Default = DEFAULT = only icons.
88     
89    DRAWERSHOWAS = (DEFAULT|ICON|TEXT_NAME|TEXT_DATE|TEXT_SIZE|TEXT_TYPE)
90    
91      View Mode. Icons or Text sorted by name/date/size/type.
92      Optional. Default = DEFAULT = inherit from parent view
93      mode.
94      
95    TRANSPARENT = <integer>
96    
97      Transparent (mask) color in ILBM image(s). Use -1 for no transparency.
98      Default = 0.