diff options
author | Matthias Clasen <maclas@gmx.de> | 2003-06-17 20:31:22 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2003-06-17 20:31:22 +0000 |
commit | c426f10d3b7157c5e1b290192e2abf7e902bc2b3 (patch) | |
tree | 83b83cd2ea2dbac72647b44b1e7e70008773f681 | |
parent | 4e4877a6069d04ec7473d74b406518b0b4657df1 (diff) | |
download | pango-c426f10d3b7157c5e1b290192e2abf7e902bc2b3.tar.gz |
Add rule to regenerate man pages from Docbook. (man_MANS): Add
2003-06-17 Matthias Clasen <maclas@gmx.de>
* docs/Makefile.am: Add rule to regenerate man pages from
Docbook.
(man_MANS): Add pango-querymodules.1.
(content_files): Add pangoe-querymodules.xml.
* docs/pango-querymodules.xml: New refentry.
* docs/pango-querymodules.1: Man page generated from the .xml source.
* docs/pango-docs.sgml: Include pango-querymodules.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 | 20 | ||||
-rw-r--r-- | ChangeLog.pre-1-10 | 20 | ||||
-rw-r--r-- | ChangeLog.pre-1-4 | 20 | ||||
-rw-r--r-- | ChangeLog.pre-1-6 | 20 | ||||
-rw-r--r-- | ChangeLog.pre-1-8 | 20 | ||||
-rw-r--r-- | acinclude.m4 | 46 | ||||
-rw-r--r-- | configure.in | 20 | ||||
-rw-r--r-- | docs/Makefile.am | 12 | ||||
-rw-r--r-- | docs/pango-docs.sgml | 7 | ||||
-rw-r--r-- | docs/pango-querymodules.1 | 49 | ||||
-rw-r--r-- | docs/pango-querymodules.xml | 53 |
11 files changed, 281 insertions, 6 deletions
@@ -1,4 +1,22 @@ -2003-06-17 Matthias Clasen <mc2@YAST_ASK> +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * docs/Makefile.am: Add rule to regenerate man pages from + Docbook. + (man_MANS): Add pango-querymodules.1. + (content_files): Add pangoe-querymodules.xml. + + * docs/pango-querymodules.xml: New refentry. + + * docs/pango-querymodules.1: Man page generated from the .xml source. + + * docs/pango-docs.sgml: Include pango-querymodules.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. * docs/pango-docs.sgml: Add an autogenerated index. diff --git a/ChangeLog.pre-1-10 b/ChangeLog.pre-1-10 index 22547074..de5d2724 100644 --- a/ChangeLog.pre-1-10 +++ b/ChangeLog.pre-1-10 @@ -1,4 +1,22 @@ -2003-06-17 Matthias Clasen <mc2@YAST_ASK> +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * docs/Makefile.am: Add rule to regenerate man pages from + Docbook. + (man_MANS): Add pango-querymodules.1. + (content_files): Add pangoe-querymodules.xml. + + * docs/pango-querymodules.xml: New refentry. + + * docs/pango-querymodules.1: Man page generated from the .xml source. + + * docs/pango-docs.sgml: Include pango-querymodules.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. * docs/pango-docs.sgml: Add an autogenerated index. diff --git a/ChangeLog.pre-1-4 b/ChangeLog.pre-1-4 index 22547074..de5d2724 100644 --- a/ChangeLog.pre-1-4 +++ b/ChangeLog.pre-1-4 @@ -1,4 +1,22 @@ -2003-06-17 Matthias Clasen <mc2@YAST_ASK> +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * docs/Makefile.am: Add rule to regenerate man pages from + Docbook. + (man_MANS): Add pango-querymodules.1. + (content_files): Add pangoe-querymodules.xml. + + * docs/pango-querymodules.xml: New refentry. + + * docs/pango-querymodules.1: Man page generated from the .xml source. + + * docs/pango-docs.sgml: Include pango-querymodules.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. * docs/pango-docs.sgml: Add an autogenerated index. diff --git a/ChangeLog.pre-1-6 b/ChangeLog.pre-1-6 index 22547074..de5d2724 100644 --- a/ChangeLog.pre-1-6 +++ b/ChangeLog.pre-1-6 @@ -1,4 +1,22 @@ -2003-06-17 Matthias Clasen <mc2@YAST_ASK> +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * docs/Makefile.am: Add rule to regenerate man pages from + Docbook. + (man_MANS): Add pango-querymodules.1. + (content_files): Add pangoe-querymodules.xml. + + * docs/pango-querymodules.xml: New refentry. + + * docs/pango-querymodules.1: Man page generated from the .xml source. + + * docs/pango-docs.sgml: Include pango-querymodules.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. * docs/pango-docs.sgml: Add an autogenerated index. diff --git a/ChangeLog.pre-1-8 b/ChangeLog.pre-1-8 index 22547074..de5d2724 100644 --- a/ChangeLog.pre-1-8 +++ b/ChangeLog.pre-1-8 @@ -1,4 +1,22 @@ -2003-06-17 Matthias Clasen <mc2@YAST_ASK> +2003-06-17 Matthias Clasen <maclas@gmx.de> + + * docs/Makefile.am: Add rule to regenerate man pages from + Docbook. + (man_MANS): Add pango-querymodules.1. + (content_files): Add pangoe-querymodules.xml. + + * docs/pango-querymodules.xml: New refentry. + + * docs/pango-querymodules.1: Man page generated from the .xml source. + + * docs/pango-docs.sgml: Include pango-querymodules.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. * docs/pango-docs.sgml: Add an autogenerated index. diff --git a/acinclude.m4 b/acinclude.m4 new file mode 100644 index 00000000..65036719 --- /dev/null +++ b/acinclude.m4 @@ -0,0 +1,46 @@ +# 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 a3b6cf9a..404adbf2 100644 --- a/configure.in +++ b/configure.in @@ -563,6 +563,26 @@ dnl ************************** 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 * See whether we need to load our modules as .la files * dnl ******************************************************** diff --git a/docs/Makefile.am b/docs/Makefile.am index 25889432..6650dea9 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -48,7 +48,8 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ pango_markup.sgml \ - version.xml + version.xml \ + pango-querymodules.xml # Images to copy into HTML directory HTML_IMAGES = \ @@ -57,6 +58,15 @@ HTML_IMAGES = \ # Extra options to supply to gtkdoc-fixref FIXXREF_OPTIONS= +man_MANS = pango-querymodules.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 EXTRA_DIST += \ diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml index 0408a343..f78a86dd 100644 --- a/docs/pango-docs.sgml +++ b/docs/pango-docs.sgml @@ -17,6 +17,7 @@ <!ENTITY pango-Xft-Fonts-and-Rendering SYSTEM "xml/xft-fonts.xml"> <!ENTITY pango-OpenType-Font-Handling SYSTEM "xml/opentype.xml"> <!ENTITY markup-format SYSTEM "pango_markup.sgml"> +<!ENTITY pango-querymodules SYSTEM "pango-querymodules.xml"> <!ENTITY version SYSTEM "version.xml"> ]> <book id="index"> @@ -53,6 +54,12 @@ &pango-Modules; </chapter> + <chapter id="tools"> + <title>Pango Tools</title> + + &pango-querymodules; + </chapter> + <index/> </book> diff --git a/docs/pango-querymodules.1 b/docs/pango-querymodules.1 new file mode 100644 index 00000000..c7c34901 --- /dev/null +++ b/docs/pango-querymodules.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 "PANGO-QUERYMODULES" 1 "" "" "" +.SH NAME +pango-querymodules \- Module registration utility +.SH "SYNOPSIS" + +.nf +\fBpango-querymodules\fR [module...] +.fi + +.SH "DESCRIPTION" + +.PP + \fBpango-querymodules\fR collects information about loadable modules for Pango and writes it to \fIstdout\fR\&. + +.PP +If called without arguments, it looks for modules in the Pango 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 Pango module path is specified by the key Pango/ModulesPath in the Pango config database, which is read from \fI\fIsysconfdir\fR/pango/pangorc\fR, \fI~/\&.pangorc\fR and the file specified in the environment variable \fBPANGO_RC_FILE\fR\&. + +.SH "BUGS" + +.PP +None known yet\&. + diff --git a/docs/pango-querymodules.xml b/docs/pango-querymodules.xml new file mode 100644 index 00000000..1677d92e --- /dev/null +++ b/docs/pango-querymodules.xml @@ -0,0 +1,53 @@ +<refentry id="pango-querymodules"> + +<refmeta> +<refentrytitle>pango-querymodules</refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname>pango-querymodules</refname> +<refpurpose>Module registration utility</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>pango-querymodules</command> +<arg choice="opt" rep="repeat">module</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +<command>pango-querymodules</command> collects information about loadable +modules for Pango and writes it to <filename>stdout</filename>. +</para> +<para> +If called without arguments, it looks for modules in the Pango 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 Pango module path is specified by the key +<literal>Pango/ModulesPath</literal> in the Pango config database, which is +read from + <filename><replaceable>sysconfdir</replaceable>/pango/pangorc</filename>, + <filename>~/.pangorc</filename> and the file specified in the environment + variable <envar>PANGO_RC_FILE</envar>. +</para> +</refsect1> + +<refsect1><title>Bugs</title> +<para> +None known yet. +</para> +</refsect1> + +</refentry> + + |