gdk-pixbuf-csource.1 2.12 KB
Newer Older
Tim Janik's avatar
Tim Janik committed
1 2 3 4 5 6 7 8 9 10 11
.TH GDK-PIXBUF-CSOURCE 1 "04 Sep 2001"
.SH NAME
gdk-pixbuf-csource \- C code generation utility for GdkPixbuf images
.SH SYNOPSIS

\fBgdk-pixbuf-csource\fP [\fIoptions\fP] [\fIimage\fP]
.br
\fBgdk-pixbuf-csource\fP [\fIoptions\fP] \fI--build-list\fP [[\fIname image\fP]...]

.SH DESCRIPTION
\fBgdk-pixbuf-csource\fP is a small utility that generates C code containing
12
images, useful for compiling images directly into programs.
Tim Janik's avatar
Tim Janik committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

.SH INVOCATION

\fBgdk-pixbuf-csource\fP either takes as input one image file name to generate code
for, or, using the \fI--build-list\fP option, a list of (\fIname\fP, \fIimage\fP)
pairs to generate code for a list of images into named variables.

.SS Options
.TP
\fI--stream
Generate pixbuf data stream (a single string containing a serialized
GdkPixdata structure in network byte order).

.TP
\fI--struct
Generate GdkPixdata structure (needs the GdkPixdata structure definition from
gdk-pixdata.h).

.TP
\fI--macros
Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and
*_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image.

.TP
\fI--rle
38
Enables run-length encoding for the generated pixel data (default).
Tim Janik's avatar
Tim Janik committed
39 40 41

.TP
\fI--raw
42
Disables run-length encoding for the generated pixel data.
Tim Janik's avatar
Tim Janik committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

.TP
\fI--extern
Generate extern symbols.

.TP
\fI--static
Generate static symbols (default).

.TP
\fI--decoder
Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition
to decode run-length encoded image data.

.TP
\fI--name=identifier
59 60
Specifies the identifier name (prefix) for the generated variables or
macros (useful only if \fI--build-list\fP was not specified).
Tim Janik's avatar
Tim Janik committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

.TP
\fI--build-list
Enables (\fIname\fP, \fIimage\fP) pair parsing mode.

.TP
\fI-h, --help\fP 
Print brief help and exit.

.TP
\fI-v, --version\fP
Print version and exit.

.TP
\fI--g-fatal-warnings
Make warnings fatal (causes the program to abort).

.PP

.SH SEE ALSO
The \fIGdkPixbuf\fP documentation, shipped with the \fIGtk+\fP distribution,
available from \fIhttp://www.gtk.org\fP.

.SH BUGS 
None known yet.

.SH AUTHOR
.B gdk-pixbuf-csource
was written by Tim Janik <timj@gtk.org>.
.PP
This manual page was provided by Tim Janik <timj@gtk.org>.