<!-- $XConsortium: dtpmfile.sgm /main/9 1996/09/08 20:18:32 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<RefEntry Id="CDEMX.MAN82.rsml.1">
<RefMeta>
<RefEntryTitle>dtpmfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtpmfile</Filename></RefName>
<RefPurpose>format of X Pixmap (XPM) format desktop icon files
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<Synopsis>    /* XPM */
    static char * <Emphasis>icon_name</Emphasis>[] = {
    "<Emphasis>width height num_colors chars_per_pixel [x_hot y_hot]</Emphasis>",
    "<Emphasis>char {key color}+</Emphasis>",
    ...
    " <Symbol Role="Variable">pixels</Symbol> ",
    ...
    };
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Pixmap icons are multi-color images based on the XPM (X PixMap) format.
A pixmap file is an ASCII file, which can
be read and modified by hand, in addition to the use of color pixmap
editors (like the Icon Editor).
The XPM format was designed specifically
for small "icon" images.
XPM files can be included directly in C source
code, so the file data is in the form of a pixmap structure variable.
A pixmap file can be broken down into three main components: generic
pixmap information, pixmap colors, and the actual pixmap data.
</Para>
<Para>The generic pixmap file contains the following information:
</Para>
<ItemizedList>
<ListItem>
<Para>pixmap name
</Para>
</ListItem>
<ListItem>
<Para>pixmap width
</Para>
</ListItem>
<ListItem>
<Para>pixmap height
</Para>
</ListItem>
<ListItem>
<Para>number of colors used in pixmap
</Para>
</ListItem>
<ListItem>
<Para>number of characters per pixel
</Para>
</ListItem>
<ListItem>
<Para>x hot-spot and y hot-spot (optional)
</Para>
</ListItem>
</ItemizedList>
<Para>Each color used in the pixmap is defined by a string containing the
following information:
</Para>
<ItemizedList>
<ListItem>
<Para>character(s) used to represent this color in pixmap data
</Para>
</ListItem>
<ListItem>
<Para>symbolic name for this color
</Para>
</ListItem>
<ListItem>
<Para>mono visual to use for this color (that is, black/white)
</Para>
</ListItem>
<ListItem>
<Para>color visual by name ("red") or RGB value ("#9696c8c8afaf")
</Para>
</ListItem>
<ListItem>
<Para>gray scale visuals (most CDE icons do not include gray scale data)
</Para>
</ListItem>
</ItemizedList>
<Para>The data itself is simply strings of symbols representing colors.
There is one string per column of the pixmap, and this data will
resemble the actual icon.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following is a pixmap that can be used to represent an executable
file. The icon has a 3-D border around it and contains a lightning bolt.
</Para>
<InformalExample Remap="indent">
<ProgramListing>static char ** execute = {
"22 22 7 1",
"R s iconGray1 m white c #e1e1e1e1e1e1",
"B s iconGray3 m white c #afafafafafaf",
"~ s iconColor6 m white c yellow",
"Y s iconColor1 m black c black",
"X s iconGray2 m white c #c8c8c8c8c8c8",
"+ s iconGray7 m black c #4b4b4b4b4b4b",
"@ s iconGray5 m black c #7d7d7d7d7d7d",
"RRRRRRRRRRRRRRRRRRRBRR",
"RRRRRRRRRRRRRRRR~~BRRY",
"RRBBBBBBBBBBBBX~~YBBYY",
"RRBBBBBBBBBBBB~~YBBBYY",
"RRBBBBBBBBBB~~~YBBBBYY",
"RRBBBBBBBBX~~~YBBBBBYY",
"RRBBBBBBBB~~~YBBBBBBYY",
"RRBBBBBBX~~~~~~~~XYBYY",
"RRBBBBX~~~~~~~~XYYBBYY",
"RRBBBBBYYYY~~~XYBBBBYY",
"RRBBBBBBX~~~XYYBBBBBYY",
"RRBBBBBX~~XYYBBBBBBBYY",
"RRBBBX~~~YYYBBBBBBBBYY",
"RRBB~~~~~~~~~~~XYBBBYY",
"RRX~~~~~~~~~~X+YBBBBYY",
"RRBYYYY~~~~X+YBBBBBBYY",
"RRBBBBB~~B@YBBBBBBBBYY",
"RRBBBB~X@YYBBBBBBBBBYY",
"RRBBB~B+YBBBBBBBBBBBYY",
"RRBB~+YBBBBBBBBBBBBBYY",
"RRY~YYYYYYYYYYYYYYYYYY",
"RYYYYYYYYYYYYYYYYYYYYY"};
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>For a description of icon location, usage, design, etc. within the
CDE, refer to
&cdeman.dticonfile;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Literal>X11</Literal>Window<Literal>System</Literal>documentation,
&cdeman.dticonfile;, &cdeman.dticon;,
&cdeman.dtbmfile;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
