<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "intltool-extract">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="intltool-extract-1">

<refmeta><refentrytitle>intltool-extract</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">3<?Pub Caret> Apr 2003</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>intltool-extract</primary></indexterm><indexterm><primary>

generate header file from XML source file</primary></indexterm><refnamediv

id="intltool-extract-1-name"><refname>intltool-extract</refname><refpurpose>generate

header file from XML source file</refpurpose></refnamediv>

<refsynopsisdiv id="intltool-extract-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>-ini-style

</option></arg><arg choice="opt"><option>-help</option></arg><arg choice="opt"><option>

-verbose</option></arg><arg choice="opt"><option>-version</option></arg><arg

choice="opt"><option>-xml-style</option></arg><arg choice="opt"><option>-scheme-style

</option></arg><arg choice="plain"><replaceable>source-file</replaceable></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="intltool-extract-1-desc"><title>&desc-tt;</title>

<para><command>&cmd;</command> generates header files from the strings in

the specified input files which <command>gettext</command> can use to merge

strings into the <filename>.pot</filename> file.</para>

</refsect1>

<refsect1 id="intltool-extract-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="narrow"><varlistentry><term><option>-help</option></term>

<listitem><para>Show usage and basic help information. You can also use <option>

H</option> to specify this option.</para>

</listitem></varlistentry>

<varlistentry><term><option>-ini-style</option></term><listitem><para>Specifies

that the source file is of type <literal>gettext/ini</literal>.</para>

</listitem></varlistentry>

<varlistentry><term><option>-scheme-style</option></term><listitem><para>

Specifies that the source file is of type <literal>gettext/scheme</literal>.

You can also use <option>O</option> to specify this option.</para>

</listitem></varlistentry>

<varlistentry><term><option>-verbose</option></term><listitem><para>Provide

additional feedback. You can also use <option>X</option> to specify this option.

</para>

</listitem></varlistentry>

<varlistentry><term><option>-version</option></term><listitem><para>Show version

information. You can also use <option>V</option> to specify this option.</para>

</listitem></varlistentry>

<varlistentry><term><option>-xml-style</option></term><listitem><para>Specifies

that the source file is of type <literal>gettext/xml</literal>. You can also

use <option>O</option> to specify this option.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="intltool-extract-1-oper"><title>&oper-tt;</title>

<para>The following operands are supported:</para>

<variablelist termlength="narrow"><varlistentry><term><option role="nodash"><replaceable>

source-file</replaceable></option></term><listitem><para>Specifies the pathname

of the XML file from which to extract translatable content.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="intltool-extract-1-exam"><title>&exam-tt;</title>

<example role="example"><title>Generating a Header File for a Schemas File,

With Verbose Output</title>

<para><screen>example% <userinput>&cmd; <option>O</option> --scheme-style foo.schemas.in

</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="intltool-extract-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>

<listitem><para>Application exited successfully</para>

</listitem></varlistentry>

<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="intltool-extract-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="wide"><varlistentry><term><filename>/usr/bin/&cmd;</filename>

</term><listitem><para>The command-line executable for the application.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="intltool-extract-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-common-devel

</para></entry></row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para>Volatile</para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="intltool-extract-1-also"><title>&also-tt;</title>

<para><citerefentry><refentrytitle>intltool-merge</refentrytitle><manvolnum>

1</manvolnum></citerefentry>, <citerefentry><refentrytitle>intltool-prepare

</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>

intltool-unicodify</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>

<refentrytitle>intltool-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>

<refentrytitle>intltoolize</refentrytitle><manvolnum>1</manvolnum></citerefentry></para>

</refsect1>

<refsect1 id="intltool-extract-1-note"><title>&note-tt;</title>

<para>For more information, see the <filename>I18N-HOWTO</filename> file,

which is provided with the <application>intltool</application> source code.

</para>

<para>Updated by Damien Donlon, Sun Microsystems Inc., 2003. Written by Darin

Adler, Kenneth Christiansen, Maciej Stachowiak.</para>

</refsect1>

</refentry>

<?Pub *0000006828>