]> Pileus Git - ~andy/gtk/blobdiff - 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
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1 b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
new file mode 100644 (file)
index 0000000..9f36e4b
--- /dev/null
@@ -0,0 +1,114 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "GDK-PIXBUF-CSOURCE" 1 "" "" ""
+.SH NAME
+gdk-pixbuf-csource \- C code generation utility for GdkPixbuf images
+.SH "SYNOPSIS"
+
+.nf
+\fBgdk-pixbuf-csource\fR [options] [image]
+.fi
+
+.nf
+\fBgdk-pixbuf-csource\fR [options] --build-list [[name] [image]...]
+.fi
+
+.SH "DESCRIPTION"
+
+.PP
+ \fBgdk-pixbuf-csource\fR is a small utility that generates C code containing images, useful for compiling images directly into programs\&.
+
+.SH "INVOCATION"
+
+.PP
+ \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\&.
+
+.SS "Options"
+
+.TP
+\fB--stream\fR
+Generate pixbuf data stream (a single string containing a serialized GdkPixdata structure in network byte order)\&.
+
+.TP
+\fB--struct\fR
+Generate GdkPixdata structure (needs the GdkPixdata structure definition from \fIgdk-pixdata\&.h\fR)\&.
+
+.TP
+\fB--macros\fR
+Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and *_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image\&.
+
+.TP
+\fB--rle\fR
+Enables run-length encoding for the generated pixel data (default)\&.
+
+.TP
+\fB--raw\fR
+Disables run-length encoding for the generated pixel data\&.
+
+.TP
+\fB--extern\fR
+Generate extern symbols\&.
+
+.TP
+\fB--static\fR
+Generate static symbols (default)\&.
+
+.TP
+\fB--decoder\fR
+Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition to decode run-length encoded image data\&.
+
+.TP
+\fB--name=identifier\fR
+Specifies the identifier name (prefix) for the generated variables or macros (useful only if \fB--build-list\fR was not specified)\&.
+
+.TP
+\fB--build-list\fR
+Enables (\fIname\fR, \fIimage\fR) pair parsing mode\&.
+
+.TP
+\fB-h\fR, \fB--help\fR
+Print brief help and exit\&.
+
+.TP
+\fB-v\fR, \fB--version\fR
+Print version and exit\&.
+
+.TP
+\fB--g-fatal-warnings\fR
+Make warnings fatal (causes the program to abort)\&.
+
+.SH "SEE ALSO"
+
+.PP
+The GdkPixbuf documentation, shipped with the Gtk+ distribution, available from www\&.gtk\&.org: \fIhttp://www.gtk.org\fR\&.
+
+.SH "BUGS"
+
+.PP
+None known yet\&.
+
+.SH "AUTHOR"
+
+.PP
+ \fBgdk-pixbuf-csource\fR was written by Tim Janik <timj@gtk\&.org>\&.
+
+.PP
+This manual page was provided by Tim Janik <timj@gtk\&.org>\&.
+