]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
Add rule to regenerate man pages from Docbook. (man_MANS): Add
[~andy/gtk] / docs / reference / gdk-pixbuf / gdk-pixbuf-csource.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GDK-PIXBUF-CSOURCE" 1 "" "" ""
21 .SH NAME
22 gdk-pixbuf-csource \- C code generation utility for GdkPixbuf images
23 .SH "SYNOPSIS"
24
25 .nf
26 \fBgdk-pixbuf-csource\fR [options] [image]
27 .fi
28
29 .nf
30 \fBgdk-pixbuf-csource\fR [options] --build-list [[name] [image]...]
31 .fi
32
33 .SH "DESCRIPTION"
34
35 .PP
36  \fBgdk-pixbuf-csource\fR is a small utility that generates C code containing images, useful for compiling images directly into programs\&.
37
38 .SH "INVOCATION"
39
40 .PP
41  \fBgdk-pixbuf-csource\fR either takes as input one image file name to generate code for, or, using the \fB--build-list\fR option, a list of (\fIname\fR, \fIimage\fR) pairs to generate code for a list of images into named variables\&.
42
43 .SS "Options"
44
45 .TP
46 \fB--stream\fR
47 Generate pixbuf data stream (a single string containing a serialized GdkPixdata structure in network byte order)\&.
48
49 .TP
50 \fB--struct\fR
51 Generate GdkPixdata structure (needs the GdkPixdata structure definition from \fIgdk-pixdata\&.h\fR)\&.
52
53 .TP
54 \fB--macros\fR
55 Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and *_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image\&.
56
57 .TP
58 \fB--rle\fR
59 Enables run-length encoding for the generated pixel data (default)\&.
60
61 .TP
62 \fB--raw\fR
63 Disables run-length encoding for the generated pixel data\&.
64
65 .TP
66 \fB--extern\fR
67 Generate extern symbols\&.
68
69 .TP
70 \fB--static\fR
71 Generate static symbols (default)\&.
72
73 .TP
74 \fB--decoder\fR
75 Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition to decode run-length encoded image data\&.
76
77 .TP
78 \fB--name=identifier\fR
79 Specifies the identifier name (prefix) for the generated variables or macros (useful only if \fB--build-list\fR was not specified)\&.
80
81 .TP
82 \fB--build-list\fR
83 Enables (\fIname\fR, \fIimage\fR) pair parsing mode\&.
84
85 .TP
86 \fB-h\fR, \fB--help\fR
87 Print brief help and exit\&.
88
89 .TP
90 \fB-v\fR, \fB--version\fR
91 Print version and exit\&.
92
93 .TP
94 \fB--g-fatal-warnings\fR
95 Make warnings fatal (causes the program to abort)\&.
96
97 .SH "SEE ALSO"
98
99 .PP
100 The GdkPixbuf documentation, shipped with the Gtk+ distribution, available from www\&.gtk\&.org: \fIhttp://www.gtk.org\fR\&.
101
102 .SH "BUGS"
103
104 .PP
105 None known yet\&.
106
107 .SH "AUTHOR"
108
109 .PP
110  \fBgdk-pixbuf-csource\fR was written by Tim Janik <timj@gtk\&.org>\&.
111
112 .PP
113 This manual page was provided by Tim Janik <timj@gtk\&.org>\&.
114