Blob Blame History Raw
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!--==================================================================
  ocaml-gettext: a library to translate messages 
  
  Copyright (C) 2003-2008 Sylvain Le Gall <sylvain@le-gall.net>
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version;
  with the OCaml static compilation exception.
  
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  USA
===================================================================-->


<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
"/usr/share/xml/schema/dtd/4.3/docbookx.dtd" [
]>
<refentry>
  <refentryinfo>
    <productname>ocaml-gettext</productname>
    <productnumber/>
    <date>2008-04-29</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>OCAML-XGETTEXT</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname><command>ocaml-xgettext</command></refname>
    <refpurpose>program to extract translatable strings from OCaml source file.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>ocaml-xgettext</command>
      <arg>camlp4 arguments</arg>
      <arg><replaceable>filename</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  
  <refsect1>
    <title>DESCRIPTION</title>

    <para>
      This manual page documents briefly the <command>ocaml-xgettext</command>
    </para>
      
    <para>
      <command>ocaml-xgettext</command> is a <command>camlp4</command> top level. This top level is compiled with the 
      printer module <filename>pr_gettext.cmo</filename>. It outputs an OCaml marshalled data structure that can only
      be understood by <command>ocaml-gettext</command>. The purpose of this program is to be a back end for OCaml source
      code string extraction. You should not use it directly.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>
      <citerefentry>
        <refentrytitle><command>ocaml-gettext</command></refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>
    </para>
    <para>
      <citerefentry>
        <refentrytitle><command>camlp4</command></refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
</refentry>