<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

  <!ENTITY dhfirstname "<firstname>Christian</firstname>">
  <!ENTITY dhsurname   "<surname>Marillat</surname>">
  <!ENTITY dhdate      "<date>august  6, 2001</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>marillat@debian.org</email>">
  <!ENTITY dhusername  "Christian Marillat">
  <!ENTITY dhucpackage "<refentrytitle>gtkdoc-mktmpl</refentrytitle>">
  <!ENTITY dhpackage   "gtkdoc-mktmpl">
  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2001</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose> GTK DocBook documentation generator.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

     <arg> See below </arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> This creates or updates the
      template files which contain the manually-edited documentation. (A
      <replaceable>template</replaceable> is a simple text form which is
      filled in with the description of a function, macro, enum, or struct.
      For functions and macros it also contains fields for describing the
      parameters.)</para>

    <para>This script reads in the existing templates, found in tmpl/*.sgml,
      moves these files to tmpl/*.sgml.bak, and then recreates the .sgml
      files according to the structure given in the file
      <replaceable>MODULE</replaceable>-sections.txt.</para>

    <para>Any new templates added, or new function parameters, are marked
      with <replaceable>FIXME</replaceable> so you can do a grep to see
      which parts need updating.</para>

    <para>Any templates which are no longer used (i.e. they are remove from
      <replaceable>MODULE</replaceable>-sections.txt) are placed in the file
      tmpl/<replaceable>MODULE</replaceable>-unused.txt. If they are
      included again later they are automatically copied back into position. 
      If you are certain that these templates will never be used again you
      can delete them from <replaceable>MODULE</replaceable>-unused.txt.</para>

    <para>Any parameters to functions which are no longer used are separated
      from the rest of the parameters with the line <token><</token>!-- # Unused Parameters
      # -->. It may be that the parameter name has just been changed, in
      which case you can copy the description to the parameter with the new
      name. You can delete the unused parameter descriptions when no longer
      needed.</para>

  </refsect1>

  <refsect1>

    <title>EXAMPLE</title>

    <para>See /usr/share/doc/gtk-doc-tools/examples, for a makefile.am and a
      configure.in example file.</para>

  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
