49cf3066afdaf864541b03257d23251dd8fb94e3
[framework/uifw/xorg/lib/libxpm.git] / sxpm / sxpm.man
1 .\"Copyright (C) 1989-95 GROUPE BULL
2 .\"
3 .\"Permission is hereby granted, free of charge, to any person obtaining a copy
4 .\"of this software and associated documentation files (the "Software"), to
5 .\"deal in the Software without restriction, including without limitation the
6 .\"rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 .\"sell copies of the Software, and to permit persons to whom the Software is
8 .\"furnished to do so, subject to the following conditions:
9 .\"
10 .\"The above copyright notice and this permission notice shall be included in
11 .\"all copies or substantial portions of the Software.
12 .\"
13 .\"THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 .\"IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 .\"FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
16 .\"GROUPE BULL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
17 .\"AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18 .\"CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
19 .\"
20 .\"Except as contained in this notice, the name of GROUPE BULL shall not be
21 .\"used in advertising or otherwise to promote the sale, use or other dealings
22 .\"in this Software without prior written authorization from GROUPE BULL.
23 .\"
24 .nr )S 12
25 .TH SXPM 1
26 .PD
27 .ad b
28 .SH NAME
29 sxpm \- Show an XPM (X PixMap) file and/or convert XPM 1 or 2 files to XPM 3.
30 .SH SYNOPSIS
31 \fBsxpm\fR
32 [\|\fB-d\fR displayname\|] 
33 [\|\fB-g\fR geometry\|] 
34 [\|\fB-hints\fR\|] 
35 [\|\fB-icon\fR filename\|] 
36 [\|\fB-plaid\| | \|\fRfilename\| | \|-\|]
37 [\|\fB-o\fR filename\| | \|\fB-o\fR -\|] 
38 [\|\fB-pcmap\fR\|] 
39 [\|\fB-closecolors\fR\|] 
40 [\|\fB-nod\fR\|] 
41 [\|\fB-nom\fR\|] 
42 [\|\fB-mono | -grey4 | -grey | -color\fR\|] 
43 [\|\fB-sc\fR symbol color\|] 
44 [\|\fB-sp\fR symbol pixel\|] 
45 [\|\fB-cp\fR color pixel\|] 
46 [\|\fB-rgb\fR filename\|] 
47 [\|\fB-v\fR\|] 
48 .SH DESCRIPTION
49 .PP
50 The \fIsxpm\fP program can be used to view any XPM (version 1, 2, or 3) file
51 and/or to convert a file from XPM1 or XPM2 to XPM version 3. If \fIsxpm\fP is
52 run with any dummy option specified, the usage is displayed. If no geometry is
53 specified, the show window will have the size of the read pixmap. Pressing the
54 key Q in the window will quit the program.
55 .SH OPTIONS
56 .TP 8
57 .B \-d \fIdisplay\fP
58 Specifies the display to connect to.
59 .TP 8
60 .B \-g \fIgeom\fP
61 Window geometry (default is pixmap's size).
62 .TP 8
63 .B \-hints
64 Set ResizeInc for window.
65 .TP 8
66 .B \-icon \fIfilename\fP
67 Set icon to pixmap created from the file \fIfilename\fP.
68 .TP 8
69 .B \-plaid
70 Show the plaid pixmap which is stored as data\fP.
71 .TP 8
72 .B \fIfilename\fP
73 Read from the file \fIfilename\fP and from standard input if \fIfilename\fP is '-'.
74 If no input is specified sxpm reads from standard input.
75 .TP 8
76 .B \-o \fIfilename\fP
77 Write to the file \fIfilename\fP (overwrite if it already exists) and to
78 standard output if \fIfilename\fP is '-'.
79 .TP 8
80 .B \-mono
81 Use the colors specified for a monochrome visual.
82 .TP 8
83 .B \-grey4
84 Use the colors specified for a 4 color greyscale visual.
85 .TP 8
86 .B \-grey
87 Use the colors specified for a greyscale visual.
88 .TP 8
89 .B \-color
90 Use the colors specified for a color visual.
91 .TP 8
92 .B \-pcmap
93 Use a private colormap.
94 .TP 8
95 .B \-closecolors
96 Try to use "close colors" before reverting to other visuals.
97 .TP 8
98 .B \-nod
99 Do not display the pixmap in a window.  (Useful when using as converter)
100 .TP 8
101 .B \-nom
102 Do not use the clipmask if there is any.
103 .TP 8
104 .B \-sc \fIsymbol colorname\fP
105 Override default color to \fIsymbol\fP to \fIcolorname\fP.
106 .TP 8
107 .B \-sp \fIsymbol pixelvalue\fP
108 Override default color to \fIsymbol\fP to \fIpixelvalue\fP.
109 .TP 8
110 .B \-cp \fIcolorname pixelvalue\fP
111 Override default color to \fIcolorname\fP to \fIpixelvalue\fP.
112 .TP 8
113 .B \-rgb \fIfilename\fP
114 Search color names in the file \fIfilename\fP and write them out instead of
115 the rgb values.
116 .TP 8
117 .B \-v
118 Verbose - to print out extensions (stderr).
119
120
121 .SH KNOWN BUGS
122 Some window managers may not accept a pixmap which is not a bitmap as icon
123 because this does not respect ICCCM, many of the well known ones will accept
124 it though.
125
126 .SH AUTHOR
127 Arnaud Le Hors    (lehors@sophia.inria.fr)
128 .br
129 Bull Research France
130 .br
131 Copyright (C) 1989-95 by Groupe Bull.