Commit 54f796b1 authored by Matthias Clasen's avatar Matthias Clasen Committed by Matthias Clasen

New macros to check for XML catalog contents and path, borrowed from

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.

	* gobject/Makefile.am: Add rule to regenerate man pages from
	Docbook.
	(man_MANS): Add glib-mkenums.1, glib-genmarshal.1 and gobject-query.1.
	(content_files): Add glib-mkenums.xml, glib-genmarshal.xml and
	gobject-query.xml.

	* gobject/glib-mkenums.xml:
	* gobject/glib-genmarshal.xml:
	* gobject/gobject-query.xml: New refentries.

	* gobject/glib-mkenums.1:
	* gobject/glib-genmarshal.1:
	* gobject/gobject-query.1: Man pages generated from the .xml
	sources.

	* gobject/gobject-docs.sgml: Include glib-mkenums.xml,
	glib-genmarshal.xml and gobject-query.xml.

	* glib/Makefile.am: Add rule to regenerate man pages from
	Docbook.
	(man_MANS): Add glib-gettextize.1.
	(content_files): Add glib-gettextize.xml.

	* glib/glib-gettextize.xml: New refentry.

	* glib/glib-gettextize.1: Man page generated from the .xml source.

	* glib/glib-docs.sgml: Include glib-gettextize.xml.
parent 6411bedd
2003-06-18 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-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 Tor Lillqvist <tml@iki.fi> 2003-06-15 Tor Lillqvist <tml@iki.fi>
* glib-zip.in (DLLDIR): Test where the DLLs actually are. * glib-zip.in (DLLDIR): Test where the DLLs actually are.
......
2003-06-18 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-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 Tor Lillqvist <tml@iki.fi> 2003-06-15 Tor Lillqvist <tml@iki.fi>
* glib-zip.in (DLLDIR): Test where the DLLs actually are. * glib-zip.in (DLLDIR): Test where the DLLs actually are.
......
2003-06-18 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-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 Tor Lillqvist <tml@iki.fi> 2003-06-15 Tor Lillqvist <tml@iki.fi>
* glib-zip.in (DLLDIR): Test where the DLLs actually are. * glib-zip.in (DLLDIR): Test where the DLLs actually are.
......
2003-06-18 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-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 Tor Lillqvist <tml@iki.fi> 2003-06-15 Tor Lillqvist <tml@iki.fi>
* glib-zip.in (DLLDIR): Test where the DLLs actually are. * glib-zip.in (DLLDIR): Test where the DLLs actually are.
......
2003-06-18 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-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 Tor Lillqvist <tml@iki.fi> 2003-06-15 Tor Lillqvist <tml@iki.fi>
* glib-zip.in (DLLDIR): Test where the DLLs actually are. * glib-zip.in (DLLDIR): Test where the DLLs actually are.
......
2003-06-18 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-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 Tor Lillqvist <tml@iki.fi> 2003-06-15 Tor Lillqvist <tml@iki.fi>
* glib-zip.in (DLLDIR): Test where the DLLs actually are. * glib-zip.in (DLLDIR): Test where the DLLs actually are.
......
...@@ -73,6 +73,52 @@ if test $ac_cv_func_printf_unix98 = yes; then ...@@ -73,6 +73,52 @@ if test $ac_cv_func_printf_unix98 = yes; then
fi fi
])# AC_FUNC_PRINTF_UNIX98 ])# AC_FUNC_PRINTF_UNIX98
# 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
])
...@@ -1896,6 +1896,26 @@ dnl ************************** ...@@ -1896,6 +1896,26 @@ dnl **************************
GTK_DOC_CHECK([1.0]) GTK_DOC_CHECK([1.0])
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)
dnl ****************************** dnl ******************************
dnl *** output the whole stuff *** dnl *** output the whole stuff ***
dnl ****************************** dnl ******************************
......
2003-06-18 Matthias Clasen <maclas@gmx.de>
* gobject/Makefile.am: Add rule to regenerate man pages from
Docbook.
(man_MANS): Add glib-mkenums.1, glib-genmarshal.1 and gobject-query.1.
(content_files): Add glib-mkenums.xml, glib-genmarshal.xml and
gobject-query.xml.
* gobject/glib-mkenums.xml:
* gobject/glib-genmarshal.xml:
* gobject/gobject-query.xml: New refentries.
* gobject/glib-mkenums.1:
* gobject/glib-genmarshal.1:
* gobject/gobject-query.1: Man pages generated from the .xml
sources.
* gobject/gobject-docs.sgml: Include glib-mkenums.xml,
glib-genmarshal.xml and gobject-query.xml.
2003-06-17 Matthias Clasen <maclas@gmx.de>
* glib/Makefile.am: Add rule to regenerate man pages from
Docbook.
(man_MANS): Add glib-gettextize.1.
(content_files): Add glib-gettextize.xml.
* glib/glib-gettextize.xml: New refentry.
* glib/glib-gettextize.1: Man page generated from the .xml source.
* glib/glib-docs.sgml: Include glib-gettextize.xml.
2003-06-17 Matthias Clasen <mc2@YAST_ASK> 2003-06-17 Matthias Clasen <mc2@YAST_ASK>
* gobject/gobject-docs.sgml: * gobject/gobject-docs.sgml:
......
...@@ -48,11 +48,21 @@ content_files = \ ...@@ -48,11 +48,21 @@ content_files = \
changes.sgml \ changes.sgml \
compiling.sgml \ compiling.sgml \
resources.sgml \ resources.sgml \
version.xml version.xml \
glib-gettextize.xml
# Extra options to supply to gtkdoc-fixref # Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS= FIXXREF_OPTIONS=
man_MANS = glib-gettextize.1
if ENABLE_MAN
%.1 : %.xml
@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
endif
# include common portion ... # include common portion ...
include $(top_srcdir)/gtk-doc.make include $(top_srcdir)/gtk-doc.make
......
...@@ -61,6 +61,8 @@ ...@@ -61,6 +61,8 @@
<!ENTITY glib-Resources SYSTEM "resources.sgml"> <!ENTITY glib-Resources SYSTEM "resources.sgml">
<!ENTITY glib-Changes SYSTEM "changes.sgml"> <!ENTITY glib-Changes SYSTEM "changes.sgml">
<!ENTITY glib-gettextize SYSTEM "glib-gettextize.xml">
<!ENTITY version SYSTEM "version.xml"> <!ENTITY version SYSTEM "version.xml">
]> ]>
<book id="index"> <book id="index">
...@@ -155,7 +157,13 @@ OS/2 and BeOS. GLib is released under the GNU Library General Public License ...@@ -155,7 +157,13 @@ OS/2 and BeOS. GLib is released under the GNU Library General Public License
&glib-Caches; &glib-Caches;
&glib-Memory-Allocators; &glib-Memory-Allocators;
</chapter> </chapter>
<chapter id="tools">
<title>GLib Tools</title>
&glib-gettextize;
</chapter>
<index/> <index/>
</book> </book>
.\"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 "GLIB-GETTEXTIZE" 1 "" "" ""
.SH NAME
glib-gettextize \- gettext internationalization utility
.SH "SYNOPSIS"
.nf
\fBglib-gettextize\fR [option...] [directory]
.fi
.SH "DESCRIPTION"
.PP
\fBglib-gettextize\fR helps to prepare a source package for being internationalized through gettext\&. It is a variant of the \fBgettextize\fR that ships with gettext\&.
.PP
\fBglib-gettextize\fR differs from \fBgettextize\fR in that it doesn't create an \fIintl/\fR subdirectory and doesn't modify \fIpo/ChangeLog\fR (note that newer versions of \fBgettextize\fR behave like this when called with the \fB--no-changelog\fR option)\&.
.SS "Options"
.TP
\fB--help\fR
print help and exit
.TP
\fB--version\fR
print version information and exit
.TP
\fB-c\fR, \fB--copy\fR
copy files instead of making symlinks
.TP
\fB-f\fR, \fB--force\fR
force writing of new files even if old ones exist
.SH "SEE ALSO"
.PP
\fBgettextize\fR(1)
<refentry id="glib-gettextize">
<refmeta>
<refentrytitle>glib-gettextize</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>glib-gettextize</refname>
<refpurpose>gettext internationalization utility</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>glib-gettextize</command>
<arg choice="opt" rep="repeat">option</arg>
<arg choice="opt">directory</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>
<command>glib-gettextize</command> helps to prepare a source package for being
internationalized through <application>gettext</application>.
It is a variant of the <command>gettextize</command> that ships with
<application>gettext</application>.
</para>
<para>
<command>glib-gettextize</command> differs
from <command>gettextize</command> in that it doesn't create an
<filename>intl/</filename> subdirectory and doesn't modify
<filename>po/ChangeLog</filename> (note that newer versions of
<command>gettextize</command> behave like this when called with the
<option>--no-changelog</option> option).
</para>
<refsect2><title>Options</title>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem><para>
print help and exit
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>
print version information and exit
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option>, <option>--copy</option></term>
<listitem><para>
copy files instead of making symlinks
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>, <option>--force</option></term>
<listitem><para>
force writing of new files even if old ones exist
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1><title>See also</title>
<para>
<command>gettextize</command>(1)
</para>
</refsect1>
</refentry>
...@@ -28,12 +28,29 @@ MKDB_OPTIONS= ...@@ -28,12 +28,29 @@ MKDB_OPTIONS=
HTML_IMAGES = HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
content_files = version.xml content_files = version.xml \
glib-mkenums.xml \
glib-genmarshal.xml \
gobject-query.xml
# Extra options to supply to gtkdoc-fixref # Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html
man_MANS = glib-mkenums.1 glib-genmarshal.1 gobject-query.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 include $(top_srcdir)/gtk-doc.make
# Other files to distribute # Other files to distribute
EXTRA_DIST += version.xml.in EXTRA_DIST += version.xml.in
.\"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 "GLIB-GENMARSHAL" 1 "" "" ""
.SH NAME
glib-genmarshal \- C code marshaller generation utility for GLib closures
.SH "SYNOPSIS"
.nf
\fBglib-genmarshal\fR [options...] [files...]
.fi
.SH "DESCRIPTION"
.PP
\fBglib-genmarshal\fR is a small utility that generates C code marshallers for callback functions of the GClosure mechanism in the GObject sublibrary of GLib\&. The marshaller functions have a standard signature, they get passed in the invoking closure, an array of value structures holding the callback function parameters and a value structure for the return value of the callback\&. The marshaller is then responsible to call the respective C code function of the closure with all the parameters on the stack and to collect its return value\&.
.SH "INVOKATION"
.PP
\fBglib-genmarshal\fR takes a list of marshallers to generate as input\&. The marshaller list is either read from standard input or from files passed as additional arguments on the command line\&.
.SS "Options"
.TP
\fB--header\fR
Generate header file contents of the marshallers\&.
.TP
\fB--body\fR
Generate C code file contents of the marshallers\&.
.TP
\fB--prefix=string\fR, \fB--prefix string\fR
Specify marshaller prefix\&. The default prefix is `g_cclosure_marshal'\&.
.TP
\fB--skip-source\fR
Skip source location remarks in generated comments\&.
.TP
\fB--nostdinc\fR
Do not use the standard marshallers of the GObject library, and skip \fIgmarshal\&.h\fR include directive in generated header files\&.
.TP
\fB--g-fatal-warnings\fR
Make warnings fatal, that is, exit immediately once a warning occurs\&.
.TP
\fB-h\fR, \fB--help\fR
Print brief help and exit\&.
.TP
\fB-v\fR, \fB--version\fR
Print version and exit\&.
.SS "Marshaller list format"
.PP
The marshaller lists are processed line by line, a line can contain a comment in the form of
.nf
# this is a comment
.fi
or a marshaller specification of the form
.nf
\fIRTYPE\fR:\fIPTYPE\fR
\fIRTYPE\fR:\fIPTYPE\fR,\fIPTYPE\fR
\fIRTYPE\fR:\fIPTYPE\fR,\fIPTYPE\fR,\fIPTYPE\fR
.fi
(up to 16 \fIPTYPE\fRs may be present)\&.
.PP
The \fIRTYPE\fR part specifies the callback's return type and the \fIPTYPE\fRs right to the colon specify the callback's parameter list, except for the first and the last arguments which are always pointers\&.
.SS "Parameter types"
.PP
Currently, the following types are supported:
.TP
\fIVOID\fR
indicates no return type, or no extra parameters\&. If \fIVOID\fR is used as the parameter list, no additional parameters may be present\&.
.TP
\fIBOOLEAN\fR
for boolean types (gboolean)
.TP
\fICHAR\fR
for signed char types (gchar)
.TP
\fIUCHAR\fR
for unsigned char types (guchar)
.TP
\fIINT\fR
for signed integer types (gint)
.TP
\fIUINT\fR
for unsigned integer types (guint)
.TP
\fILONG\fR
for signed long integer types (glong)
.TP
\fIULONG\fR
for unsigned long integer types (gulong)
.TP
\fIENUM\fR
for enumeration types (gint)
.TP
\fIFLAGS\fR
for flag enumeration types (guint)
.TP
\fIFLOAT\fR
for single-precision float types (gfloat)
.TP
\fIDOUBLE\fR
for double-precision float types (gdouble)
.TP
\fISTRING\fR
for string types (gchar*)