diff options
author | Matthias Clasen <maclas@gmx.de> | 2003-06-17 00:37:28 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2003-06-17 00:37:28 +0000 |
commit | fcffe5a1abb031909e85a8b5b2f1adbe587389ed (patch) | |
tree | b86fa96d53bddea9393af8d416f3d01a4a9b0b56 | |
parent | 5e4a3fbab16b7b71f4966a7e16ca8213e70a8340 (diff) | |
download | gtk+-fcffe5a1abb031909e85a8b5b2f1adbe587389ed.tar.gz |
Add rule to regenerate man pages from Docbook. (man_MANS): Add
2003-06-17 Matthias Clasen <maclas@gmx.de>
* gdk-pixbuf/Makefile.am: Add rule to regenerate man pages from
Docbook.
(man_MANS): Add gdk-pixbuf-csource.1, gdk-pixbuf-query-loaders.1.
(content_files): Add gdk-pixbuf-csource.xml,
gdk-pixbuf-query-loaders.xml.
* gdk-pixbuf/gdk-pixbuf-csource.xml: New refentry, containing the
former gdk-pixbuf/gdk-pixbuf-csource.1, converted to Docbook.
* gdk-pixbuf/gdk-pixbuf-query-loaders.xml: New refentry.
* gdk-pixbuf/gdk-pixbuf-csource.1:
* gdk-pixbuf/gdk-pixbuf-query-loaders.1: Man pages generated from
the .xml sources.
* gdk-pixbuf/gdk-pixbuf.sgml: Include gdk-pixbuf-csource.xml and
gdk-pixbuf-query-loaders.xml.
* gtk/Makefile.am: Add rule to regenerate man pages from Docbook.
(man_MANS): Add gtk-query-immodules-2.0.1
(content_files): Add gtk-query-immodules-2.0.xml
* gtk/gtk-query-immodules-2.0.xml: New refentry.
* gtk/gtk-query-immodules-2.0.1: Man page generated from the .xml
source.
* gtk/gtk-docs.sgml: Include gtk-query-immodules-2.0.xml.
* acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New
macros to check for XML catalog contents and path, borrowed from
gtk-doc.
* configure.in: New option --enable-man to enable regeneration of
man pages from Docbook, if the necessary tools are found.
-rw-r--r-- | ChangeLog | 8 | ||||
-rw-r--r-- | ChangeLog.pre-2-10 | 8 | ||||
-rw-r--r-- | ChangeLog.pre-2-4 | 8 | ||||
-rw-r--r-- | ChangeLog.pre-2-6 | 8 | ||||
-rw-r--r-- | ChangeLog.pre-2-8 | 8 | ||||
-rw-r--r-- | acinclude.m4 | 47 | ||||
-rw-r--r-- | configure.in | 20 | ||||
-rw-r--r-- | docs/reference/ChangeLog | 31 | ||||
-rw-r--r-- | docs/reference/gdk-pixbuf/Makefile.am | 13 | ||||
-rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1 | 114 | ||||
-rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml | 171 | ||||
-rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.1 | 49 | ||||
-rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml | 51 | ||||
-rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf.sgml | 16 | ||||
-rw-r--r-- | docs/reference/gtk/Makefile.am | 12 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-docs.sgml | 10 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-query-immodules-2.0.1 | 49 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-query-immodules-2.0.xml | 50 | ||||
-rw-r--r-- | gdk-pixbuf/Makefile.am | 6 |
19 files changed, 670 insertions, 9 deletions
@@ -1,3 +1,11 @@ +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New + macros to check for XML catalog contents and path, borrowed from + gtk-doc. + * configure.in: New option --enable-man to enable regeneration of + man pages from Docbook, if the necessary tools are found. + 2003-06-15 Matthias Clasen <maclas@gmx.de> * gtk/gtkcalendar.c (gtk_calendar_class_init): diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 2347ce2963..dad0e8e98f 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,11 @@ +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New + macros to check for XML catalog contents and path, borrowed from + gtk-doc. + * configure.in: New option --enable-man to enable regeneration of + man pages from Docbook, if the necessary tools are found. + 2003-06-15 Matthias Clasen <maclas@gmx.de> * gtk/gtkcalendar.c (gtk_calendar_class_init): diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 2347ce2963..dad0e8e98f 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,11 @@ +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New + macros to check for XML catalog contents and path, borrowed from + gtk-doc. + * configure.in: New option --enable-man to enable regeneration of + man pages from Docbook, if the necessary tools are found. + 2003-06-15 Matthias Clasen <maclas@gmx.de> * gtk/gtkcalendar.c (gtk_calendar_class_init): diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 2347ce2963..dad0e8e98f 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,11 @@ +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New + macros to check for XML catalog contents and path, borrowed from + gtk-doc. + * configure.in: New option --enable-man to enable regeneration of + man pages from Docbook, if the necessary tools are found. + 2003-06-15 Matthias Clasen <maclas@gmx.de> * gtk/gtkcalendar.c (gtk_calendar_class_init): diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 2347ce2963..dad0e8e98f 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,11 @@ +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * acinclude.m4 (JH_PATH_XML_CATALOG, JH_CHECK_XML_CATALOG): New + macros to check for XML catalog contents and path, borrowed from + gtk-doc. + * configure.in: New option --enable-man to enable regeneration of + man pages from Docbook, if the necessary tools are found. + 2003-06-15 Matthias Clasen <maclas@gmx.de> * gtk/gtkcalendar.c (gtk_calendar_class_init): diff --git a/acinclude.m4 b/acinclude.m4 index 664a989fc7..ed6e888994 100644 --- a/acinclude.m4 +++ b/acinclude.m4 @@ -10,3 +10,50 @@ AC_DEFUN([GLIB_AC_DIVERT_BEFORE_HELP], [AC_DIVERT_PUSH(AC_DIVERSION_NOTICE)dnl $1 AC_DIVERT_POP()])])]) + +# Checks the location of the XML Catalog +# Usage: +# JH_PATH_XML_CATALOG +# Defines XMLCATALOG and XML_CATALOG_FILE substitutions +AC_DEFUN([JH_PATH_XML_CATALOG], +[ + # check for the presence of the XML catalog + AC_ARG_WITH([xml-catalog], + AC_HELP_STRING([--with-xml-catalog=CATALOG], + [path to xml catalog to use]),, + [with_xml_catalog=/etc/xml/catalog]) + XML_CATALOG_FILE="$with_xml_catalog" + AC_MSG_CHECKING([for XML catalog ($XML_CATALOG_FILE)]) + if test -f "$XML_CATALOG_FILE"; then + AC_MSG_RESULT([found]) + else + AC_MSG_RESULT([not found]) + AC_MSG_ERROR([XML catalog not found]) + fi + AC_SUBST([XML_CATALOG_FILE]) + + # check for the xmlcatalog program + AC_PATH_PROG(XMLCATALOG, xmlcatalog, no) + if test "x$XMLCATALOG" = xno; then + AC_MSG_ERROR([could not find xmlcatalog program]) + fi +]) + +# Checks if a particular URI appears in the XML catalog +# Usage: +# JH_CHECK_XML_CATALOG(URI, [FRIENDLY-NAME], [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND]) +AC_DEFUN([JH_CHECK_XML_CATALOG], +[ + AC_REQUIRE([JH_PATH_XML_CATALOG])dnl + AC_MSG_CHECKING([for ifelse([$2],,[$1],[$2]) in XML catalog]) + if AC_RUN_LOG([$XMLCATALOG --noout "$XML_CATALOG_FILE" "$1" >&2]); then + AC_MSG_RESULT([found]) + ifelse([$3],,,[$3 +])dnl + else + AC_MSG_RESULT([not found]) + ifelse([$4],, + [AC_MSG_ERROR([could not find ifelse([$2],,[$1],[$2]) in XML catalog])], + [$4]) + fi +]) diff --git a/configure.in b/configure.in index 674b3c9ac5..a28660a6cb 100644 --- a/configure.in +++ b/configure.in @@ -1467,6 +1467,26 @@ GTK_DOC_CHECK([1.0]) AC_CHECK_PROG(DB2HTML, db2html, true, false) AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML) +AC_ARG_ENABLE(man, + [AC_HELP_STRING([--enable-man], + [regenerate man pages from Docbook [default=no]])],enable_man=yes, + enable_man=no) + +dnl +dnl Check for xsltproc +dnl +AC_PATH_PROG([XSLTPROC], [xsltproc]) +if test -z "$XSLTPROC"; then + enable_man=no +fi + +dnl check for DocBook DTD and stylesheets in the local catalog. +JH_CHECK_XML_CATALOG([-//OASIS//DTD DocBook XML V4.1.2//EN], + [DocBook XML DTD V4.1.2],,enable_man=no) +JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl], + [DocBook XSL Stylesheets],,enable_man=no) +AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno) + ################################################## # Output commands ################################################## diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 2cecc0d26d..dc87129ac1 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,4 +1,33 @@ -2003-06-17 Matthias Clasen <mc2@YAST_ASK> +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * gdk-pixbuf/Makefile.am: Add rule to regenerate man pages from + Docbook. + (man_MANS): Add gdk-pixbuf-csource.1, gdk-pixbuf-query-loaders.1. + (content_files): Add gdk-pixbuf-csource.xml, + gdk-pixbuf-query-loaders.xml. + + * gdk-pixbuf/gdk-pixbuf-csource.xml: New refentry, containing the + former gdk-pixbuf/gdk-pixbuf-csource.1, converted to Docbook. + + * gdk-pixbuf/gdk-pixbuf-query-loaders.xml: New refentry. + + * gdk-pixbuf/gdk-pixbuf-csource.1: + * gdk-pixbuf/gdk-pixbuf-query-loaders.1: Man pages generated from + the .xml sources. + + * gdk-pixbuf/gdk-pixbuf.sgml: Include gdk-pixbuf-csource.xml and + gdk-pixbuf-query-loaders.xml. + + * gtk/Makefile.am: Add rule to regenerate man pages from Docbook. + (man_MANS): Add gtk-query-immodules-2.0.1 + (content_files): Add gtk-query-immodules-2.0.xml + + * gtk/gtk-query-immodules-2.0.xml: New refentry. + + * gtk/gtk-query-immodules-2.0.1: Man page generated from the .xml + source. + + * gtk/gtk-docs.sgml: Include gtk-query-immodules-2.0.xml. * gtk/gtk-docs.sgml: * gdk-pixbuf/gdk-pixbuf.sgml: diff --git a/docs/reference/gdk-pixbuf/Makefile.am b/docs/reference/gdk-pixbuf/Makefile.am index 8dd29dcc8d..7893c29ce0 100644 --- a/docs/reference/gdk-pixbuf/Makefile.am +++ b/docs/reference/gdk-pixbuf/Makefile.am @@ -52,7 +52,9 @@ content_files = \ gdk-pixbuf-from-drawables.sgml \ gdk-pixbuf-rendering.sgml \ gdk-pixbuf.sgml \ - porting-from-imlib.sgml + porting-from-imlib.sgml \ + gdk-pixbuf-csource.xml \ + gdk-pixbuf-query-loaders.xml # Images to copy into HTML directory HTML_IMAGES = @@ -60,6 +62,15 @@ HTML_IMAGES = # Extra options to supply to gtkdoc-fixref FIXXREF_OPTIONS= +man_MANS = gdk-pixbuf-csource.1 gdk-pixbuf-query-loaders.1 + +if ENABLE_MAN + +%.1 : %.xml + @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +endif + include $(top_srcdir)/gtk-doc.make # Other files to distribute diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1 b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1 new file mode 100644 index 0000000000..9f36e4b2ef --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1 @@ -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>\&. + diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml new file mode 100644 index 0000000000..fdb785405d --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml @@ -0,0 +1,171 @@ +<refentry id="gdk-pixbuf-csource"> + +<refmeta> +<refentrytitle>gdk-pixbuf-csource</refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname>gdk-pixbuf-csource</refname> +<refpurpose>C code generation utility for GdkPixbuf images</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>gdk-pixbuf-csource</command> +<arg choice="opt">options</arg> +<arg choice="opt">image</arg> +</cmdsynopsis> +<cmdsynopsis> +<command>gdk-pixbuf-csource</command> +<arg choice="opt">options</arg> +<arg choice="plain">--build-list</arg> +<arg rep="repeat"> + <arg>name</arg> + <arg>image</arg> +</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +<command>gdk-pixbuf-csource</command> is a small utility that generates C code +containing images, useful for compiling images directly into programs. +</para> +</refsect1> + +<refsect1><title>Invocation</title> +<para> +<command>gdk-pixbuf-csource</command> either takes as input one image file name +to generate code for, or, using the <option>--build-list</option> option, a +list of (<replaceable>name</replaceable>, <replaceable>image</replaceable>) +pairs to generate code for a list of images into named variables. +</para> +<refsect2><title>Options</title> +<variablelist> + +<varlistentry> +<term><option>--stream</option></term> +<listitem><para> +Generate pixbuf data stream (a single string containing a serialized +<structname>GdkPixdata</structname> structure in network byte order). +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--struct</option></term> +<listitem><para> +Generate GdkPixdata structure (needs the <structname>GdkPixdata</structname> +structure definition from <filename>gdk-pixdata.h</filename>). +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--macros</option></term> +<listitem><para> +Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and +*_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--rle</option></term> +<listitem><para> +Enables run-length encoding for the generated pixel data (default). +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--raw</option></term> +<listitem><para> +Disables run-length encoding for the generated pixel data. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--extern</option></term> +<listitem><para> +Generate extern symbols. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--static</option></term> +<listitem><para> +Generate static symbols (default). +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--decoder</option></term> +<listitem><para> +Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition +to decode run-length encoded image data. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--name=identifier</option></term> +<listitem><para> +Specifies the identifier name (prefix) for the generated variables or +macros (useful only if <option>--build-list</option> was not specified). +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--build-list</option></term> +<listitem><para> +Enables (<replaceable>name</replaceable>, <replaceable>image</replaceable>) +pair parsing mode. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>-h</option>, <option>--help</option></term> +<listitem><para> +Print brief help and exit. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>-v</option>, <option>--version</option></term> +<listitem><para> +Print version and exit. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--g-fatal-warnings</option></term> +<listitem><para> +Make warnings fatal (causes the program to abort). +</para></listitem> +</varlistentry> + +</variablelist> +</refsect2> +</refsect1> + +<refsect1><title>See also</title> +<para> +The <structname>GdkPixbuf</structname> documentation, shipped with the +Gtk+ distribution, available from <ulink url="http://www.gtk.org">www.gtk.org</ulink>. +</para> +</refsect1> + +<refsect1><title>Bugs</title> +<para> +None known yet. +</para> +</refsect1> + +<refsect1><title>Author</title> +<para> +<command>gdk-pixbuf-csource</command> was written by Tim Janik +<email>timj@gtk.org</email>. +</para> +<para> +This manual page was provided by Tim Janik <email>timj@gtk.org</email>. +</para> +</refsect1> +</refentry> + diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.1 b/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.1 new file mode 100644 index 0000000000..b6ba22cffb --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.1 @@ -0,0 +1,49 @@ +.\"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-QUERY" 1 "" "" "" +.SH NAME +gdk-pixbuf-query-loaders \- GdkPixbuf loader registration utility +.SH "SYNOPSIS" + +.nf +\fBgdk-pixbuf-query-loaders\fR [module...] +.fi + +.SH "DESCRIPTION" + +.PP + \fBgdk-pixbuf-query-loaders\fR collects information about loadable modules for gdk-pixbuf and writes it to \fIstdout\fR\&. + +.PP +If called without arguments, it looks for modules in the gdk-pixbuf loader directory\&. + +.PP +If called with arguments, it looks for the specified modules\&. The arguments may be absolute or relative paths\&. + +.SH "ENVIRONMENT" + +.PP +The environment variable \fBGDK_PIXBUF_MODULEDIR\fR can be used to specify a different loader directory\&. The default gdk-pixbuf loader directory is \fI\fIlibdir\fR/gtk-2\&.0/\fIversion\fR/loaders\fR\&. + +.SH "BUGS" + +.PP +None known yet\&. + diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml b/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml new file mode 100644 index 0000000000..576c4b6fa2 --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml @@ -0,0 +1,51 @@ +<refentry id="gdk-pixbuf-query-loaders"> + +<refmeta> +<refentrytitle>gdk-pixbuf-query-loaders</refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname>gdk-pixbuf-query-loaders</refname> +<refpurpose>GdkPixbuf loader registration utility</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>gdk-pixbuf-query-loaders</command> +<arg choice="opt" rep="repeat">module</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +<command>gdk-pixbuf-query-loaders</command> collects information about loadable +modules for <application>gdk-pixbuf</application> and writes it to <filename>stdout</filename>. +</para> +<para> +If called without arguments, it looks for modules in the +<application>gdk-pixbuf</application> loader directory. +</para> +<para> +If called with arguments, it looks for the specified modules. The arguments +may be absolute or relative paths. +</para> +</refsect1> + +<refsect1><title>Environment</title> +<para> +The environment variable <envar>GDK_PIXBUF_MODULEDIR</envar> can be used +to specify a different loader directory. The default <application>gdk-pixbuf</application> loader +directory is <filename><replaceable>libdir</replaceable>/gtk-2.0/<replaceable>version</replaceable>/loaders</filename>. +</para> +</refsect1> + +<refsect1><title>Bugs</title> +<para> +None known yet. +</para> +</refsect1> + +</refentry> + + diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml index cf52e17bde..2bd853624d 100644 --- a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml @@ -25,6 +25,8 @@ <!ENTITY gdk-pixbuf "<application>gdk-pixbuf</application>"> <!ENTITY Imlib "<application>Imlib</application>"> <!ENTITY version SYSTEM "version.xml"> +<!ENTITY gdk-pixbuf-csource SYSTEM "gdk-pixbuf-csource.xml"> +<!ENTITY gdk-pixbuf-query-loaders SYSTEM "gdk-pixbuf-query-loaders.xml"> ]> <book id="index"> @@ -114,6 +116,20 @@ &gdk-pixbuf-gdk-pixbuf-xlib-rgb; </reference> + <reference> + <title>Tools Reference</title> + + <partintro> + <para> + This part presents the tools which are shipped with the + &gdk-pixbuf; library. + </para> + </partintro> + + &gdk-pixbuf-csource; + &gdk-pixbuf-query-loaders; + </reference> + <index/> &Porting-From-Imlib; diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index e52276a4d2..80a4ca53fb 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -81,7 +81,8 @@ content_files = \ text_widget.sgml \ tree_widget.sgml \ windows.sgml \ - x11.sgml + x11.sgml \ + gtk-query-immodules-2.0.xml # Images to copy into HTML directory HTML_IMAGES = \ @@ -159,6 +160,15 @@ HTML_IMAGES = \ # Extra options to supply to gtkdoc-fixref FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +man_MANS = gtk-query-immodules-2.0.1 + +if ENABLE_MAN + +%.1 : %.xml + @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +endif + include $(top_srcdir)/gtk-doc.make # Other files to distribute diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index b616a0c93c..017e0815d7 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -157,6 +157,7 @@ <!ENTITY gtk-Changes-1-2 SYSTEM "changes-1.2.sgml"> <!ENTITY gtk-Changes-2-0 SYSTEM "changes-2.0.sgml"> <!ENTITY version SYSTEM "version.xml"> +<!ENTITY gtk-query-immodules SYSTEM "gtk-query-immodules-2.0.xml"> ]> <book id="index"> <bookinfo> @@ -288,6 +289,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or <part id="gtkobjects"> <title>GTK+ Widgets and Objects</title> + <chapter> <title>Object Hierarchy</title> &index-Object-Tree; @@ -357,6 +359,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or &GtkListStore; &GtkTreeStore; </chapter> + <chapter id="MenusAndCombos"> <title>Menus, Combo Box, Toolbar</title> &GtkCombo; @@ -478,9 +481,16 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or &GtkTree; &GtkTreeItem; </chapter> + </part> + <part> + <title>GTK+ Tools</title> + + >k-query-immodules; </part> <index/> </book> + + diff --git a/docs/reference/gtk/gtk-query-immodules-2.0.1 b/docs/reference/gtk/gtk-query-immodules-2.0.1 new file mode 100644 index 0000000000..7f38a37121 --- /dev/null +++ b/docs/reference/gtk/gtk-query-immodules-2.0.1 @@ -0,0 +1,49 @@ +.\"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 "GTK-QUERY-IMMODUL" 1 "" "" "" +.SH NAME +gtk-query-immodules-2.0 \- Input method module registration utility +.SH "SYNOPSIS" + +.nf +\fBgtk-query-immodules-2.0\fR [module...] +.fi + +.SH "DESCRIPTION" + +.PP + \fBgtk-query-immodules-2.0\fR collects information about loadable input method modules for GTK+ and writes it to \fIstdout\fR\&. + +.PP +If called without arguments, it looks for modules in the GTK+ input method module path\&. + +.PP +If called with arguments, it looks for the specified modules\&. The arguments may be absolute or relative paths\&. + +.SH "ENVIRONMENT" + +.PP +The environment variable \fBGTK_PATH\fR can be used to prepend directories to the input method module path\&. + +.SH "BUGS" + +.PP +None known yet\&. + diff --git a/docs/reference/gtk/gtk-query-immodules-2.0.xml b/docs/reference/gtk/gtk-query-immodules-2.0.xml new file mode 100644 index 0000000000..6e2443ddf2 --- /dev/null +++ b/docs/reference/gtk/gtk-query-immodules-2.0.xml @@ -0,0 +1,50 @@ +<refentry id="gtk-query-immodules-2.0"> + +<refmeta> +<refentrytitle>gtk-query-immodules-2.0</refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname>gtk-query-immodules-2.0</refname> +<refpurpose>Input method module registration utility</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>gtk-query-immodules-2.0</command> +<arg choice="opt" rep="repeat">module</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +<command>gtk-query-immodules-2.0</command> collects information about loadable +input method modules for GTK+ and writes it to <filename>stdout</filename>. +</para> +<para> +If called without arguments, it looks for modules in the GTK+ input method +module path. +</para> +<para> +If called with arguments, it looks for the specified modules. The arguments +may be absolute or relative paths. +</para> +</refsect1> + +<refsect1><title>Environment</title> +<para> +The environment variable <link linkend="GTK_PATH"><envar>GTK_PATH</envar></link> can +be used to prepend directories to the input method module path. +</para> +</refsect1> + +<refsect1><title>Bugs</title> +<para> +None known yet. +</para> +</refsect1> + +</refentry> + + diff --git a/gdk-pixbuf/Makefile.am b/gdk-pixbuf/Makefile.am index b1c214df4c..2fd3114715 100644 --- a/gdk-pixbuf/Makefile.am +++ b/gdk-pixbuf/Makefile.am @@ -283,12 +283,6 @@ gdk_pixbuf_query_loaders_SOURCES = queryloaders.c # -# manual pages to install -# -man_MANS = gdk-pixbuf-csource.1 - - -# # The GdkPixBuf library # libgdk_pixbufincludedir = $(includedir)/gtk-2.0/gdk-pixbuf |