summaryrefslogtreecommitdiff
path: root/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1')
-rw-r--r--docs/reference/gdk-pixbuf/gdk-pixbuf-csource.164
1 files changed, 34 insertions, 30 deletions
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1 b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
index 9f36e4b2e..a98fde75e 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
@@ -21,77 +21,81 @@
.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
+.ad l
+.hy 0
+.HP 19
+\fBgdk\-pixbuf\-csource\fR [options] [image]
+.ad
+.hy
+.ad l
+.hy 0
+.HP 19
+\fBgdk\-pixbuf\-csource\fR [options] \-\-build\-list [[name]\ [image]...]
+.ad
+.hy
.SH "DESCRIPTION"
.PP
- \fBgdk-pixbuf-csource\fR is a small utility that generates C code containing images, useful for compiling images directly into programs\&.
+ \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\&.
+ \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
+\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)\&.
+\fB\-\-struct\fR
+Generate GdkPixdata structure (needs the GdkPixdata structure definition from \fIgdk\-pixdata\&.h\fR)\&.
.TP
-\fB--macros\fR
+\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)\&.
+\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\&.
+\fB\-\-raw\fR
+Disables run\-length encoding for the generated pixel data\&.
.TP
-\fB--extern\fR
+\fB\-\-extern\fR
Generate extern symbols\&.
.TP
-\fB--static\fR
+\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\&.
+\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)\&.
+\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
+\fB\-\-build\-list\fR
Enables (\fIname\fR, \fIimage\fR) pair parsing mode\&.
.TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
Print brief help and exit\&.
.TP
-\fB-v\fR, \fB--version\fR
+\fB\-v\fR, \fB\-\-version\fR
Print version and exit\&.
.TP
-\fB--g-fatal-warnings\fR
+\fB\-\-g\-fatal\-warnings\fR
Make warnings fatal (causes the program to abort)\&.
.SH "SEE ALSO"
@@ -102,12 +106,12 @@ The GdkPixbuf documentation, shipped with the Gtk+ distribution, available from
.SH "BUGS"
.PP
-None known yet\&.
+The runlength encoder gets out of sync with the pixel boundaries, since it includes the rowstride padding in the encoded stream\&. Furthermore, it generates pixbufs with suboptimal rowstride in some cases\&.
.SH "AUTHOR"
.PP
- \fBgdk-pixbuf-csource\fR was written by Tim Janik <timj@gtk\&.org>\&.
+ \fBgdk\-pixbuf\-csource\fR was written by Tim Janik <timj@gtk\&.org>\&.
.PP
This manual page was provided by Tim Janik <timj@gtk\&.org>\&.